semvec/pypi-packages huggingface dataset:
sand-atlas 1.2.0
A python package for processing 3d volumetric data to build meshes for the Sand Atlas data repository
Requires Python: >=3.8
Keywords: 3d, data, granular, meshes, particles, sand, volumetric

# Sand Atlas
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[Documentation here](https://scigem.github.io/sand-atlas-python/), or compile it yourself following the details below.

## Installation
First, install `ffmpeg` and `blender` on your system. Both of these need to be available in your system path (so that running `ffmpeg` and `blender` in the command line works).

This package can then be installed via `pip install sand-atlas`. If installing from github, try cloning and then running:
```
pip install -e .
```
If you make any changes to the source code, re-run those two lines to have your changes reflected in your installed package.

## Usage

### Processing particles
If you are interested in reproducing a dataset that is available in the Sand Atlas, you can use the installed script `sand_atlas_process`, like so:

```
sand_atlas_process <path_to_json_file> --label <path_to_labelled_image> --raw <path_to_raw_image>
```

If you supply only the raw image, the script will attempt to label the image for you. If you supply the labelled image, the script will use that to generate the dataset. The `json` file contains the metadata for the dataset you are interested in. The `json` files for the datasets in the Sand Atlas are available [here](https://github.com/scigem/sand-atlas/tree/main/_data/sands).

### VDB files
VDB files are the industry standard for level set data. They can be viewed in recent versions of the open source software `blender`, via `Add -> Volume -> Import OpenVDB`. If you would like to use these files in a python environment that doesn't include the `pyopenvdb` package, you can use the `vdb_to_npy` script provided by the `sand_atlas` package to convert the VDB file to a numpy array:
```
vdb_to_npy <path_to_vdb_file>
```

This will produce a `.npy` file in the same directory where you run the script. You can then load this file in python with `np.load`:
```python
import numpy as np
data = np.load('path_to_npy_file.npy')
```

### Downloading particles from the python API
You can query the server to get a list of all of the available types of particles with
```
import sand_atlas
particles = sand_atlas.data.list()
print(particles)
```

If you would like to download all of the particles with a particular mesh quality to the current working directory, you do this via
```
import sand_atlas
sand_atlas.data.get_all('SAND-NAME', MESH-QUALITY)
```

If you would like to download a specific particle, you can do this via
```
import sand_atlas
sand_atlas.data.get_by_id('SAND-NAME', MESH-QUALITY, PARTICLE-ID)
```

## Documentation

We use `sphinx` to manage the docs. Update documentation with:
```
cd docs
make html
```
Once these are built, you can commit and push the changes to github to have them refreshed on github pages. You can also view them locally.
xdynamo 0.10.0
Use dynamo with xmodel objects.
Requires Python: <4.0,>=3.10

![PythonSupport](https://img.shields.io/static/v1?label=python&message=%203.10|%203.11|%203.12&color=blue?style=flat-square&logo=python)
![PyPI version](https://badge.fury.io/py/xdynamo.svg?)

This is pre-release software, and needs to be refactored in a few ways and needs more  natural documentation with examples.  Right now the documentation is in the ([API Reference](https://xyngular.GitHub.io/py-xdynamo/latest/api/xdynamo/)) documentation section.  The natural overview/high-level docs have yet to be written

Here are a few other related libraries I wrote written that are in a much better state with good documentation, if you want to see other examples of my work:

- https://github.com/xyngular/py-xinject
    - A simple dependency injection library
- https://github.com/xyngular/py-xcon
    - Fast dynamic configuration retriever
    - Can create a flat list of config values based on various config sources and paths environment (for environmental differences and so on).
- https://github.com/xyngular/py-xsettings
    - Centralize settings for a project.
    - Can be used with xcon (see above).
    - Know immediately if a setting can't be found as soon as it's asked for vs letting the incorrect setting value cause a problem/crash it happen later on, and then having to back-track it. 

## Documentation

**[📄 Detailed Documentation](https://xyngular.github.io/py-xdynamo/latest/)** | **[🐍 PyPi](https://pypi.org/project/xdynamo/)**

## Getting Started

**warning "Alpha Software!"**

This is pre-release Alpha software, based on another code base and
the needed changes to make a final release version are not yet
completed. Everything is subject to change; and documentation needs
to be written.


```shell
poetry install xdynamo
```

or

```shell
pip install xdynamo
```