Add toolkit installation instructions
Browse files
README.md
CHANGED
|
@@ -289,7 +289,15 @@ Every temperature assignment applies to all three phases. Every view remains wit
|
|
| 289 |
|
| 290 |
## Custom generation
|
| 291 |
|
| 292 |
-
The CrysMTM toolkit supports arbitrary rotation counts per parent, seeds, explicit Euler angles or matrices, optional rendering, export and a `paper` orientation preset. The preset replays the recovered archive matrices around the origin, including identity, to coordinate precision. It does not recreate the sampling algorithm or guarantee byte-identical newly rendered images/text. Use this `augmented` configuration for original archived files.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 293 |
|
| 294 |
## Provenance and license
|
| 295 |
|
|
|
|
| 289 |
|
| 290 |
## Custom generation
|
| 291 |
|
| 292 |
+
The CrysMTM toolkit supports arbitrary rotation counts per parent, seeds, explicit Euler angles or matrices, optional rendering, export and a `paper` orientation preset. The preset replays the recovered archive matrices around the origin, including identity, to coordinate precision. It does not recreate the sampling algorithm or guarantee byte-identical newly rendered images/text. Use this `augmented` configuration for original archived files. Install the [versioned wheel](toolkit/crysmtm-2.0.0-py3-none-any.whl) with pip, or download the [source distribution](toolkit/crysmtm-2.0.0.tar.gz). The public GitHub v2 code has not yet been pushed.
|
| 293 |
+
|
| 294 |
+
```bash
|
| 295 |
+
pip install "https://huggingface.co/datasets/kurbanintelligencelab/CrysMTM/resolve/v2.0.0/toolkit/crysmtm-2.0.0-py3-none-any.whl"
|
| 296 |
+
crysmtm fetch --output ./data
|
| 297 |
+
crysmtm generate ./data --rotations-per-structure 1000 --seed 42 --output ./generated
|
| 298 |
+
```
|
| 299 |
+
|
| 300 |
+
Generation defaults to XYZ/coordinates and geometric text. Install the optional rendering extra from the wheel to generate images. See the source README for rendering, explicit angles/matrices, phase/temperature filters and the `paper` preset.
|
| 301 |
|
| 302 |
## Provenance and license
|
| 303 |
|