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.

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

Nomad entry point and raman app #22

Draft
wants to merge 18 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 16 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,7 @@ cython_debug/
.pyenv
*.pyc
*.txt
!src/download_rod_files/*.txt
!tests/data/witec/*.txt
!examples/witec/txt/*.txt
!requirements.txt
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,6 @@ within the field of raman into a standardized representation using the
## Docs
Extensive documentation of this pynxtools plugin is available [here](https://fairmat-nfdi.github.io/pynxtools-raman/). You can find information about getting started, how-to guides, the supported file formats, how to get involved, and much more there.


## Contact person in FAIRmat for this reader
Ron Hildebrandt
10 changes: 9 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,20 @@ classifiers = [
]
dependencies = [
"pynxtools>=0.7.0",
"gemmi>=0.6.7"
"gemmi>=0.6.7",
"requests>=2.32.3",
]

[project.entry-points."pynxtools.reader"]
raman = "pynxtools_raman.reader:RamanReader"

[project.entry-points.'nomad.plugin']
#raman_example = "pynxtools_raman.nomad:raman_example"
raman_app = "pynxtools_raman.nomad:raman_app"

[project.scripts]
download_rod_file = "pynxtools_raman.rod.rod_get_file:trigger_rod_download"

[tool.setuptools.packages.find]
where = [
"src",
Expand Down
43 changes: 43 additions & 0 deletions src/download_rod_files/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Downloading multiple .rod files

## Manually downloading

You can download a rod file with `ÌD=1000679` via:
`download_rod_file 1000679`


## Download_rods_script.sh

Adjust the file `download_rods_script.sh`to the range of download you want.
Default start is `1` and default end is `3`.
Be careful: Do not trigger unneccsary amounts of downloads.

Take a look [here](https://solsa.crystallography.net/rod/result), to get valid .rod IDs.
The list of .rod IDs can be accessed [here](https://solsa.crystallography.net/rod/result.php?format=lst&CODSESSION=ooqj2idj19cgpe30275okg42df).
## Add the command as script

`chmod +x download_rods_script.sh`

## Exectutute the script

`./src/download_rod_files/download_rods_script.sh`


## Convert the downloaded .rod files

via the pynxtools-raman command:

`dataconverter <PATH_TO>/1000679.rod src/pynxtools_raman/config/config_file_rod.json --reader raman --nxdl NXraman --output rod_example_neuxs.nxs`

## Downloading all .rod files

Take a look at the file: "download_all_rod_files_script.sh"

# Automatec conversion of all .rod files to .nxs files

## Add the command as script
`chmod +x convert_all_rod_to_nxs.sh`

## Call the script
`./src/download_rod_files/convert_all_rod_to_nxs.sh`

Loading
Loading