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

Uploaded Source

Built Distribution

pyiron_base-0.7.9-py3-none-any.whl (285.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyiron_base-0.7.9.tar.gz
  • Upload date:
  • Size: 226.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for pyiron_base-0.7.9.tar.gz
Algorithm Hash digest
SHA256 3d04a29757a1626f376aa718234d0db8d46eeab2d0cda1d73701489c43e085fa
MD5 b76b4b37db81dc7dd474df0f90d43c1e
BLAKE2b-256 bfc4e1edf335e73fc8a2a36a53efbf4390cbee8f041fc7758bf7efedf33d593e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyiron_base-0.7.9-py3-none-any.whl
  • Upload date:
  • Size: 285.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for pyiron_base-0.7.9-py3-none-any.whl
Algorithm Hash digest
SHA256 5e2c5f694d3dad27e7670563d10b81be0d84dab6c6529a80e963ee9548c960cd
MD5 7334a44b016ca267d80c3f18580b7641
BLAKE2b-256 e3844bca8f0d06ce8b9e671870871a10b8f44c2e3e9653665e463d974a9b5fd2

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