Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

48 documentation of the plugin #78

Merged
merged 63 commits into from
Sep 18, 2024
Merged

48 documentation of the plugin #78

merged 63 commits into from
Sep 18, 2024

Conversation

budschi
Copy link
Collaborator

@budschi budschi commented Sep 4, 2024

This is a first version of the docs of this plugin. It is based on the same docs as for the NOMAD-Measurement plugin: FAIRmat-NFDI/nomad-measurements#117
It includes:

  • Home with an overview on the plugin
  • Explaination with Levels of schema and schemas and readers (place holder)
  • contact page
  • How-To Guides on Install this Plugin, Use this Plugin (place holder) and Develop this Plugin (place holder)

Todos:

  • review existing md files
  • Home: update wich methods are coming soon
  • add content to Use this Plugin
  • add content to Develop this Plugin
  • add content to schemas and readers

@budschi budschi added this to the Version 1.0.0 milestone Sep 4, 2024
@budschi budschi self-assigned this Sep 4, 2024
@budschi budschi linked an issue Sep 4, 2024 that may be closed by this pull request
Documentation of the plugin #48
Closed
@budschi
Copy link
Collaborator Author

budschi commented Sep 6, 2024 •
edited by hampusnasstrom
Loading

  • Explantation:

  • install: @budschi

    • remove git and put pypi style installation

  • how to use. @budschi

    • pre note: you can use already in the example Oasis or install first see above
    • no specializing: instantiatiate directly in NOMAD --> e.g. solution @ka-sarthak
    • one example with yaml : solution and add a addtional qunatity,
    • one example with python inheriting and specializing --> just show import @hampusnasstrom

  • Develop --> contribute

    • general idea: extract general things from your custom schema which should go to the community plugin
    • testing in your own plugin
    • open issue
    • create pull request

  • References: add all docstrings @hampusnasstrom , minimum: link to metainfo explorer in example-oasis @budschi

  • Tutorial: there is no specific tutorial yet. Please look up the tut 13 for plugins and 12 general plugin, 8 for yaml @budschi

  • Contact: @budschi

    • first Discord
    • remove email
    • put general
    • Hampus pvd, Andrea cvd, Sarthak solutions

budschi and others added 24 commits September 6, 2024 14:14
@budschi
small fixes on index.md
be8f696
@budschi
update install.md
cef71e5
@budschi
update contribute to plugin docs
0cbc16c
@budschi
update contact.md
6750c51
@budschi
add tutorials to docs
93a6ab1
@aalbino2
data model docs
6179e33
@aalbino2 @ka-sarthak
@markus1978 @hampusnasstrom
refactor plugin structure (#69)
48a0f82 
* refactored structure

* updated toml file and relaunched ruff linting

* further lintage activities

* fixed ruff formatting and test files

* reverted nomad-lab version in toml

* added aliases and updated README

* extended conductivity-type quantity

* added carrier density deviation quantity

* harmonized type=float everywhere

* remove unused import

* filled default values in special Geometry shapes

* Bump up nomad-lab to 1.3.4dev

* fixed reference to substrate holder

* InsertReduction class refinements

* fixed InsertReduction reference

* refined recipe classes

* refined recipe classes

* added starting and ending T in annealing step

* Update src/nomad_material_processing/solution/__init__.py

Co-authored-by: Sarthak Kapoor <[email protected]>

* reformatting

* check if aliases work

* reverted m_def to old paths in test files

* reverted solution m_def

* reverted nomad_material_processing.vapor_deposition.pvd.general.PhysicalVaporDeposition

* added print statement in tests

* added print statement in tests

* Explicitely load metainfo before tests. (#72)

Co-authored-by: Hampus Näsström <[email protected]>

* remove unused import

* formatting

---------

Co-authored-by: Sarthak Kapoor <[email protected]>
Co-authored-by: Sarthak Kapoor <[email protected]>
Co-authored-by: Markus Scheidgen <[email protected]>
Co-authored-by: Hampus Näsström <[email protected]>
@aalbino2
added todo
d002ecf
@aalbino2
level of schema docs
afda932
@aalbino2
description module by module
1443771
@budschi
add text to "how-to-use"
4a16d22
@aalbino2
moved schemas_and_readers to data_model
56051e6
@budschi
add text to references
df55703
@aalbino2
added nomad_material_processing.vapor_deposition.general
aa6fa77
@budschi
fix typos in develop.md
003437d
@budschi
delete old text blocks from develop.md
b8b8ac0
@budschi
fix small errors in install.md
d5ca664
@ka-sarthak
Bugfix: rename in mkdocs.yml
f945f40
@ka-sarthak
Add explanation for solution schema
fe27e0d
@aalbino2
added CVD
cbfab88
@budschi
modify refernces
db58740
@budschi @ka-sarthak
add doc structure from nomad measurements
5757687
@budschi @ka-sarthak
update docs analog to Measurements
a25a37e
@budschi @ka-sarthak
small fixes on index.md
003580f
@ka-sarthak ka-sarthak force-pushed the 48-documentation-of-the-plugin branch from 39839b1 to 0839cfe Compare September 12, 2024 13:52
@aalbino2 aalbino2 self-requested a review September 13, 2024 14:43
@aalbino2 aalbino2 marked this pull request as ready for review September 13, 2024 14:43
ka-sarthak
ka-sarthak approved these changes Sep 17, 2024
View reviewed changes
Copy link
Collaborator

@ka-sarthak ka-sarthak left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added the information for setting up dev env and minor changes.

As we are not using docs/explanation/data_model.md and docs/how_to/use_this_plugin_old.md, we can remove them.

Otherwise looks good!

@hampusnasstrom hampusnasstrom merged commit 88fe014 into main Sep 18, 2024
5 checks passed
@hampusnasstrom hampusnasstrom deleted the 48-documentation-of-the-plugin branch September 18, 2024 08:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aalbino2 aalbino2 aalbino2 approved these changes

@ka-sarthak ka-sarthak ka-sarthak approved these changes

Assignees

@budschi budschi

Labels
None yet
Projects
None yet
Milestone
Version 1.0.0
Development

Successfully merging this pull request may close these issues.

Documentation of the plugin
4 participants
@budschi @ka-sarthak @aalbino2 @hampusnasstrom