Skip to main content

Core components of the pyiron integrated development environment (IDE) for computational materials science

Project description

Coverage Status Release_Date Build Status Downloads Documentation Status

pyiron - an integrated development environment (IDE) for computational materials science. While the general pyiron framework is focused on atomistic simulations, pyiron_base is independent of atomistic simulation. It can be used as a standalone workflow management combining a hierachical storage interface based on HDF5, support for HPC computing clusters and a user interface integrated in the Jupyter environment.

Installation

You can test pyiron on Mybinder.org (beta). For a local installation we recommend to install pyiron inside an anaconda environment:

conda install -c conda-forge pyiron_base

See the Documentation-Installation page for more details.

Example

After the successful configuration you can start your first pyiron calculation. Navigate to the the projects directory and start a jupyter notebook or jupyter lab session correspondingly:

cd ~/pyiron/projects
jupyter notebook

Open a new jupyter notebook and inside the notebook you can now validate your pyiron calculation by creating a test project:

from pyiron import Project
pr = Project('test')
pr.path

Getting started:

Test pyiron with mybinder:

mybinder

License and Acknowledgments

pyiron_base is licensed under the BSD license.

If you use pyiron in your scientific work, please consider citing

@article{pyiron-paper,
  title = {pyiron: An integrated development environment for computational materials science},
  journal = {Computational Materials Science},
  volume = {163},
  pages = {24 - 36},
  year = {2019},
  issn = {0927-0256},
  doi = {https://doi.org/10.1016/j.commatsci.2018.07.043},
  url = {http://www.sciencedirect.com/science/article/pii/S0927025618304786},
  author = {Jan Janssen and Sudarsan Surendralal and Yury Lysogorskiy and Mira Todorova and Tilmann Hickel and Ralf Drautz and Jörg Neugebauer},
  keywords = {Modelling workflow, Integrated development environment, Complex simulation protocols},
}

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

pyiron_base-0.8.3.tar.gz (230.3 kB view details)

Uploaded Source

Built Distribution

pyiron_base-0.8.3-py3-none-any.whl (289.3 kB view details)

Uploaded Python 3

File details

Details for the file pyiron_base-0.8.3.tar.gz.

File metadata

  • Download URL: pyiron_base-0.8.3.tar.gz
  • Upload date:
  • Size: 230.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for pyiron_base-0.8.3.tar.gz
Algorithm Hash digest
SHA256 aba4e7399c544c39b0bb1fc6b05ba1c1a44380c7ea8cac9ce40dc73eec70248d
MD5 2f696de5617e62c67c9bd9c48e8cb414
BLAKE2b-256 21752f6ac247eacac9e2189f25a162fd610ac0a98ef744bad97bb8ea4c6be47f

See more details on using hashes here.

File details

Details for the file pyiron_base-0.8.3-py3-none-any.whl.

File metadata

  • Download URL: pyiron_base-0.8.3-py3-none-any.whl
  • Upload date:
  • Size: 289.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for pyiron_base-0.8.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9a827686193960619489ebbbc7f74d1616c7612c097f27ad7b2ca0f3a9a12d9b
MD5 c2d2d2292734a2d5df7f1186a6626780
BLAKE2b-256 d508b7adea3770df5b85a5ea7db7a973fa6b9a6b63e3b4420747f9b815faf594

See more details on using hashes here.

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