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.4.tar.gz (1.9 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mccoygroup_mcutils-1.4.4.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.4.tar.gz
Algorithm Hash digest
SHA256 3567b19d45765e095d0608bea7e94f44430b743af678aa723fda3e803cb8ba37
MD5 bf1ac604f36b16a694a3a2634e69334e
BLAKE2b-256 086945f20b4876b4e1574f74092f6ed1630e357fc2f4dafe2a82a358602f4d01

See more details on using hashes here.

Provenance

The following attestation bundles were made for mccoygroup_mcutils-1.4.4.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.4-py3-none-any.whl.

File metadata

File hashes

Hashes for mccoygroup_mcutils-1.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 0e56835cc9a0c6b75f8c387fcf2550e29876120629763e11ecd754bc6a20ed47
MD5 cc5db55b355d74b235518c0e0b5571dc
BLAKE2b-256 e76a8a314681e47afa7b9d868b6ba975ffdb45d56562370329bb6b66032f2166

See more details on using hashes here.

Provenance

The following attestation bundles were made for mccoygroup_mcutils-1.4.4-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