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

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.1.tar.gz (108.9 kB view details)

Uploaded Source

Built Distribution

VESIcal-1.0.1-py3-none-any.whl (122.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: VESIcal-1.0.1.tar.gz
  • Upload date:
  • Size: 108.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/50.3.1 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6

File hashes

Hashes for VESIcal-1.0.1.tar.gz
Algorithm Hash digest
SHA256 ac2bd575923bca200f75698f5bb5176279d96adcb4a5418cdeefba65de0ab7a7
MD5 3272b68fcfc1599ad81d8565e00a2a7b
BLAKE2b-256 d46c700dbbeba7a0f833ed0534c2cd8b560acb0d67222a9a7a9d24cb75274269

See more details on using hashes here.

File details

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

File metadata

  • Download URL: VESIcal-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 122.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/50.3.1 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6

File hashes

Hashes for VESIcal-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5c7dc7b47ac681904ef8619af0994083beb82d02b9af6e5be5dc41c26eae97bb
MD5 9586084bcea330975addb5a630436704
BLAKE2b-256 e65b92964632ec61cfcb589b278012c354248d8d7dc673b734619a7c6d15634b

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