Skip to main content

No project description provided

Project description

McUtils Binder

McUtils is a set of utilities written by the McCoy group for the McCoy group to handle common things we do, like pulling data from electronic structure calculations, doing unit conversions, interpolating functions, making attractive plots, getting finite difference derivatives, performing fast, vectorized operations, etc.

We're working on documenting the package, but writing good documentation takes more time than writing good code. Docs for the actively edited, unstable branch can be found here.

Installation & Requirements

The easiest way to install is via pip, as

pip install mccoygroup-mcutils

This should install all dependencies. The major requirement is that Python 3.8+ is required due to use of features in the types module. For safety, it is best to install this in a virtual environment, which we can make like

python3.8 -m pip venv mcenv

and activate like

. mcenv/bin/activate

or to use it in a container or conda environment or some other place where we can control the environment.

It is also possible to install from source like

git clone https://github.com/McCoyGroup/McUtils.git

but in this case you will need to make sure the library is on the path yourself and all of the dependencies are installed. If you want to get all of the nice JHTML features for working in Jupyter, you'll then need to run

from McUtils.Jupyter import JHTML
JHTML.load()

and then reload the browser window when prompted.

Contributing

If you'd like to help out with this, we'd love contributions. The easiest way to get started with it is to try it out. When you find bugs, please report them. If there are things you'd like added let us know, and we'll try to help you get the context you need to add them yourself. One of the biggest places where people can help out, though, is in improving the quality of the documentation. As you try things out, add them as examples, either to the main page or to a child page. You can also edit the docstrings in the code to add context, explanation, argument types, return types, etc.

Project details


Download files

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

Source Distribution

mccoygroup_mcutils-1.4.2.tar.gz (1.9 MB view details)

Uploaded Source

Built Distribution

mccoygroup_mcutils-1.4.2-py3-none-any.whl (2.9 MB view details)

Uploaded Python 3

File details

Details for the file mccoygroup_mcutils-1.4.2.tar.gz.

File metadata

  • Download URL: mccoygroup_mcutils-1.4.2.tar.gz
  • Upload date:
  • Size: 1.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mccoygroup_mcutils-1.4.2.tar.gz
Algorithm Hash digest
SHA256 e3910c3c7e7862b257616fe3e0958786012f46bf31fa481d806cb36459d7ae7a
MD5 21718da37aa83927978e4fac52530d8c
BLAKE2b-256 4849505f3762061e6fbc200968cabfc8c03993078792575e442089c3b210da6f

See more details on using hashes here.

Provenance

The following attestation bundles were made for mccoygroup_mcutils-1.4.2.tar.gz:

Publisher: publish.yml on McCoyGroup/McUtils

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mccoygroup_mcutils-1.4.2-py3-none-any.whl.

File metadata

File hashes

Hashes for mccoygroup_mcutils-1.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c98e293e0e1af520641aef6bb92a1b8bb036a7169097435635478bef828c7d18
MD5 2d45a1ed5581ab92c466695f726ea365
BLAKE2b-256 acec5245a0c4fc15ebedf3ae82006f687a1350043b660a6918b389c380745c5b

See more details on using hashes here.

Provenance

The following attestation bundles were made for mccoygroup_mcutils-1.4.2-py3-none-any.whl:

Publisher: publish.yml on McCoyGroup/McUtils

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page