Skip to main content

Table of Contents generated with DocToc

e3psi

python3 CircleCI Coverage Status Code style: black Commitizen friendly security: bandit DeepSource dependabot Requirements Status

About

Equivariant machine learning library for learning from electronic structures

Development

First things first

You can develop on Windows, GNU/Linux or Mac OS X. You need:

Getting Started

First, fork this repository, then fire up your command prompt and ...

  1. Clone the forked repository
  2. Navigate to the cloned project directory: cd e3psi
  3. activate your python virtual environment and pip install -r requirements.txt.
  4. pre-commit install
  5. pre-commit install --hook-type commit-msg
  6. pre-commit run --all-files

Now you can start working on the code.

Tests

Simply run pytest. For more detailed output, including test coverage:

pytest -vv --cov=. --cov-report term-missing

Contributing

If you would like to contribute to the project:

  • if you're making code contributions, please try and write some tests to accompany your code, and ensure that the tests pass.
  • commit your changes via cz commit. Follow the prompts. When you're done, pre-commit will be invoked to ensure that your contributions and commits follow defined conventions. See pre-commit-config.yaml for more details.
  • your commit messages should follow the conventions described here. Write your commit message in the imperative: "Fix bug" and not "Fixed bug" or "Fixes bug." This convention matches up with commit messages generated by commands like git merge and git revert. Once you are done, please create a pull request.

Metadata

Release files for e3psi 0.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for e3psi 0.3.1
File Size Uploaded Provenance Actions
e3psi-0.3.1.tar.gz 18.6 kB Without provenance Details for e3psi-0.3.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for e3psi 0.3.1
File Interpreter ABI Platform Actions
e3psi-0.3.1-py3-none-any.whl Python 3 none any Details for e3psi-0.3.1-py3-none-any.whl

Total release size: 31.5 kB

Release files / e3psi-0.3.1.tar.gz

Download URL e3psi-0.3.1.tar.gz
Size 18.6 kB
Tags Source
SHA-256 checksum
How to use checksums
7ada985f335df8347bd0f4e42bfda6d146e4ba2aedf1551e0c9cf397092d67d9
BLAKE2b-256 checksum
How to use checksums
82c227fd3da45a7115ee71ce35745b27f0616bcbb301ede8dbf707bbe00ab8ba
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.28.1

Release files / e3psi-0.3.1-py3-none-any.whl

Download URL e3psi-0.3.1-py3-none-any.whl
Size 12.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d68bddf12d7e671bf457e0cb9c91ec6a8bd7e4f4bd724aea8db54863e4f76ad6
BLAKE2b-256 checksum
How to use checksums
91526e5485d244698bbb0ef1935364686d0b5fb52e060c02fb76d132cf4c8f3f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.28.1

Security for e3psi 0.3.1

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page