Skip to main content

Highly configurable 2D (SVG) & 3D (threejs) visualisations for ASE/Pymatgen structures, within the Jupyter Notebook

Project description

ase-notebook

CI Status Coverage Code style: black RTD PyPI Conda

A highly configurable 2D (SVG) & 3D (threejs) visualisation creator for ASE/Pymatgen structures, within the Jupyter Notebook.

Example SVG

Purpose

To create atomic configuration visualisations, principally within a Jupyter Notebook.

Contributing

Contributions are very welcome.

The following will discover and run all unit test:

>> pip install -e .[testing]
>> pytest -v

Coding Style Requirements

The code style is tested using flake8, with the configuration set in .flake8, and code should be formatted with black.

Installing with ase-notebook[code_style] makes the pre-commit package available, which will ensure these tests are passed by reformatting the code and testing for lint errors before submitting a commit. It can be setup by:

>> cd ase-notebook
>> pre-commit install

Optionally you can run black and flake8 separately:

>> black .
>> flake8 .

Editors like VS Code also have automatic code reformat utilities, which can adhere to this standard.

License

See LICENSE file

Issues

If you encounter any problems, please file an issue along with a detailed description.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ase-notebook-0.3.1.tar.gz (47.0 kB view details)

Uploaded Source

Built Distribution

ase_notebook-0.3.1-py3-none-any.whl (50.9 kB view details)

Uploaded Python 3

File details

Details for the file ase-notebook-0.3.1.tar.gz.

File metadata

  • Download URL: ase-notebook-0.3.1.tar.gz
  • Upload date:
  • Size: 47.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.6.7

File hashes

Hashes for ase-notebook-0.3.1.tar.gz
Algorithm Hash digest
SHA256 9be0e78d4ffebdf9eda881664187154f2439942131dfd40157e1cad36e606cbb
MD5 c2663eb90fabf7b56e178591ba098c98
BLAKE2b-256 2af8b95becbfb4df416ef37c8e9baeff6251fb38a053288e57fcdb775e980352

See more details on using hashes here.

Provenance

File details

Details for the file ase_notebook-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: ase_notebook-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 50.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.6.7

File hashes

Hashes for ase_notebook-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 269ef9b7862393673ff17e72f52b9a67689fb0800009d989531d3736ac2e17ae
MD5 653037e53f8bbad64e47b5ff664b31aa
BLAKE2b-256 ac89348c59314c843dc5f3d2c607336c65da9b2851de9d4799da95ff0df2f3f5

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page