This release is a pre-release and may not be stable for production use.
The goal of the nxxrdct project is to provide a python API to create, load, edit, and save NXxrdct application definition files.
Please find at https://nxxrdct.readthedocs.io/en/latest/ the latest documentation
pip install nxxrdct
Add the optional extras when you need documentation or development tooling:
pip install nxxrdct[doc,test]
Quick Start
import numpy as np
import pint
from nxxrdct import NXxrdct
ureg = pint.get_application_registry()
nx = NXxrdct()
nx.title = "Demo XRD-CT"
nx.beam.incident_energy = 60 * ureg.keV
nx.sample.name = "sample-01"
nx.sample.translation_values = np.linspace(-1, 1, 64) * ureg.mm
nx.sample.rotation_angles = np.linspace(0, 180, 181) * ureg.degree
nx.instrument.detector.radial_axis = np.linspace(1, 15, 1000) * ureg.degree
nx.instrument.detector.radial_axis_long_name = "2theta"
# Azimuthally integrated intensity, shape (nTrans, nRot, nRadialBins)
nx.instrument.detector.data = np.zeros((64, 181, 1000))
nx.instrument.detector.count_time = 0.1 * ureg.second
nx.save("demo_xrdct.nxs", data_path="entry")
Documentation and Support
- Latest documentation: https://nxxrdct.readthedocs.io/en/latest/
- API reference: https://nxxrdct.readthedocs.io/en/latest/api.html
- Report issues and follow development on GitHub: https://github.com/nexuscontributions/nxxrdct/issues
Contributing
Contributions and feedback are welcome. Please open an issue or submit a merge request on Github. See the development guide in doc/development for details on setting up a local environment and running the test suite.
License
nxxrdct is released under the MIT License. See LICENSE for the full text.
Release files for nxxrdct 0.1.0b0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| nxxrdct-0.1.0b0.tar.gz | 17.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| nxxrdct-0.1.0b0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 36.6 kB
Release files / nxxrdct-0.1.0b0.tar.gz
| Download URL | nxxrdct-0.1.0b0.tar.gz |
|---|---|
| Size | 17.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6c6b4de7102314a31a1d682e296e6707535a8c549c56180a21a5caced819b65a
|
|
BLAKE2b-256 checksum How to use checksums |
45ec03635a82c8a5206ec5174eaab196785bab05363f1f92d99ad68af0af1b98
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
Release files / nxxrdct-0.1.0b0-py3-none-any.whl
| Download URL | nxxrdct-0.1.0b0-py3-none-any.whl |
|---|---|
| Size | 19.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e02437795d74fd880ffcd624a1ba39ca48e0c8e41f34706464c4a229979cdd61
|
|
BLAKE2b-256 checksum How to use checksums |
15ba2da17db5ee240fe1ac362fe257cdeb67fb686daca63b0d2b4ee6ed5d6416
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
