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.1.tar.gz (229.9 kB view details)

Uploaded Source

Built Distribution

pyiron_base-0.8.1-py3-none-any.whl (288.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyiron_base-0.8.1.tar.gz
  • Upload date:
  • Size: 229.9 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.1.tar.gz
Algorithm Hash digest
SHA256 d2dcd0e024daabbbbb2bb86df4ae9ffa95c49b053195e019eec60fab8b32451d
MD5 96c248b9dc6ead709e6c2ea62903868f
BLAKE2b-256 dc940da2343802cb8a4c4dac21047a357e456498aeae47f9c569e0e72cfb5960

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyiron_base-0.8.1-py3-none-any.whl
  • Upload date:
  • Size: 288.9 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a358419ee278c58312bb97f563c6425ac5ef8fa991eb87116621ecb699a2e27d
MD5 c5a88bf828a2111aea8982abb3c37eab
BLAKE2b-256 c173da033f7776674863eb2d1fd66c301e9d45a36d83b0f2735d971bf28419ff

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