Octopost contains a pool of python3 tools for post-processing data obtained with the TDDFT code OCTOPUS[1].
Octopost can be imported like any Python package into your analysis scripts and provides a set of easy-to-use methods for extracting, preparing and even plotting standard information like bandstructure, various (projected) density of states, reciprocal cell for periodic systems and so on. The main focus, however, lies in the ARPES (Angle-Resolved PhotoEmission Spectroscopy) methods which make calculating ARPES maps (also called k-maps) easy and quick. The calculated maps can be plotted and exported in a .hdf5 file compatible with the POT (Photoemssion Orbital Tomography) simulation and analysis software kMap.py[2].
Quick-start
pip install octopost
Installation
It is generally recommended but not required to use a virtual enviroment like venv or conda for this package. For a tutorial on how to use them please see here.
User
As a user you only need the subset of packages nessecary to run the package. The package will also not be installed in an editable form. The package will be added to your current enviroment and will be available throughout it.:
make install
on Linux, or:
pip install .
on Windows.
Developer & Maintainer
In order to develop for Octopost it is required to use the ‘-e’ flag for pip to install in editable mode. Furthermore, it is recommended to install the ‘dev’ and ‘test’ packages as well. Simply use:
make install-dev
on Linux or:
pip install -e .[test,dev]
on Windows.
Test
If you wish to run the test suite please make sure you have Octopost and its ‘test’ dependencies installed. The latter is automatically the case if you followed the ‘Developer & Maintainer’ section of the installation guide. If you installed the ‘User’ version please additionally run:
pip install .[test]
In order to run the test use:
pytest
On Linux you can also use:
make test
Demo
Inside the ‘./demo’ folder you can find a number of small scripts showcasing different Octopost functionalities and how to use them. Due to storage constraints the actual Octopus output files required for the scripts will not be available on GitLab, however, for most scripts the output plots can be found in the ‘./demo/output’ folder.
References
[1] Nicolas Tancogne-Dejean, Micael J. T. Oliveira, Xavier Andrade, Heiko Appel, Carlos H. Borca, Guillaume Le Breton, Florian Buchholz, Alberto Castro, Stefano Corni, Alfredo A. Correa, Umberto De Giovannini, Alain Delgado, Florian G. Eich, Johannes Flick, Gabriel Gil, Adrián Gomez, Nicole Helbig, Hannes Hübener, René Jestädt, Joaquim Jornet-Somoza, Ask H. Larsen, Irina V. Lebedeva, Martin Lüders, Miguel A. L. Marques, Sebastian T. Ohlmann, Silvio Pipolo, Markus Rampp, Carlo A. Rozzi, David A. Strubbe, Shunsuke A. Sato, Christian Schäfer, Iris Theophilou, Alicia Welden, and Angel Rubio , “Octopus, a computational framework for exploring light-driven phenomena and quantum dynamics in extended and finite systems”, J. Chem. Phys. 152, 124119 (2020) https://doi.org/10.1063/1.5142502
[2] Dominik Brandstetter, Xiaosheng Yang, Daniel Lüftner, F. Stefan Tautz, and Peter Puschnig , “kMap.py: A Python program for simulation and data analysis in photoemission tomography”, Computer Physics Communications 263, 107905 (2021) https://doi.org/10.1016/j.cpc.2021.107905
1 maintainer
Metadata
1 maintainer
Release files for Octopost 1.0.0.post1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| Octopost-1.0.0.post1.tar.gz | 21.9 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| Octopost-1.0.0.post1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 44.6 kB
Release files / Octopost-1.0.0.post1.tar.gz
| Download URL | Octopost-1.0.0.post1.tar.gz |
|---|---|
| Size | 21.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e43b7f411d29b08b4bc71d3dda176b6eede68a70eb6b8c4fb93bb23ee34f99df
|
|
BLAKE2b-256 checksum How to use checksums |
0c88b36bc52c9194963e2ada0fa3a85e4b28217c46aff5dec4bf267db25320b7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12
|
Release files / Octopost-1.0.0.post1-py3-none-any.whl
| Download URL | Octopost-1.0.0.post1-py3-none-any.whl |
|---|---|
| Size | 22.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
eafbfcc046e7999d346d139b5ccaab260e3b2d5db0cb1a56278843050cbbcfb6
|
|
BLAKE2b-256 checksum How to use checksums |
73a165ca1b0b0891a58d6aeaded432515bc56053d873406a83ebf2ca64262891
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12
|
Security for Octopost 1.0.0.post1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
