Skip to main content

A generalized python library for calculating and plotting various things related to mixed volatile (H2O-CO2) solubility in silicate melts.

Project description

VESIcal

A generalized python library for calculating and plotting various things related to mixed volatile (H2O-CO2) solubility in silicate melts.

Documentation Status DOI

Use VESIcal online with no installation

Use VESIcal in Binder!

Direct link to manuscript: Manuscript on Binder

Jupyter Notebook hub with VESIcal: Manuscript on Binder

Installation

First, obtain Python3.x if you do not already have it installed. If you are new to python, we recommend installing it via anaconda3 (https://www.anaconda.com/products/individual). VESIcal can be installed with one line. Open a terminal and type the following:

pip install VESIcal

Check that the installation worked by entering the following lines into a terminal:

python
import VESIcal as v

If no output is returned, VESIcal has installed properly! You will very likely, however, see a warning telling you that no module named 'thermoengine' could be found. The installation you performed via pip attempts to install all dependencies (other libraries that VESIcal requires), but thermoengine is not available via pip and so must be manually installed.

Dependencies that should automatically be installed for you are:

  • pandas
  • numpy
  • matplotlib
  • cycler
  • abc
  • scipy
  • sys
  • sympy
  • copy

If any warnings related to these libraries appear, try installing them as you did VESIcal: with 'pip install [package]'.

thermoengine is the ENKI implementation of MELTS (MagmaSat), which is the backbone of the entire VESIcal library. VESIcal cannot be run without thermoengine at this time, however a VESIcal-lite that does not include MagmaSat is planned. To install thermoengine, please refer to the ENKI documentation here: https://gitlab.com/ENKI-portal/ThermoEngine.

Documentation

Read all of our documentation, inlcuding quickstart guides here: https://vesical.readthedocs.io/en/latest/

Check our our YouTube channel for videos on how to use VESIcal here: https://www.youtube.com/channel/UCpvCCs5KMXzOxXWm0seF8Qw

Contributing

Issues are tracked on GitHub.

Patches may be submitted via a Github pull request. All changes should include tests (VESIcal uses python's unittest library) and pass flake8.

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

VESIcal-1.0.2.tar.gz (109.3 kB view details)

Uploaded Source

Built Distribution

VESIcal-1.0.2-py3-none-any.whl (122.6 kB view details)

Uploaded Python 3

File details

Details for the file VESIcal-1.0.2.tar.gz.

File metadata

  • Download URL: VESIcal-1.0.2.tar.gz
  • Upload date:
  • Size: 109.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.7.1 requests/2.26.0 setuptools/50.3.1 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.7.6

File hashes

Hashes for VESIcal-1.0.2.tar.gz
Algorithm Hash digest
SHA256 fed47f90fb99259ab80e95e3e45e19200358ef2272e0f130bf1fc182d72446c3
MD5 51b871f4907326ed9a4c271110eba5aa
BLAKE2b-256 c52b3f9c91d31090ea399442eaeb86f57b92bc7c116775fabe178774b7097f34

See more details on using hashes here.

File details

Details for the file VESIcal-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: VESIcal-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 122.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.7.1 requests/2.26.0 setuptools/50.3.1 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.7.6

File hashes

Hashes for VESIcal-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 bddd961ce18f2f3eaee2b211d45084a3a51e6ae058c20768fc47fb2c4b32c77a
MD5 662f7eb24fab5169f55c0f9b4565b0ff
BLAKE2b-256 bdbaef089848f897a0bbf34bee60393ca49f972dc2dc7d879c3df256b2a8ef2c

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