Skip to main content

Python workflow to run Free Energy calculations

Project description

https://img.shields.io/pypi/v/amberflow.svg Documentation Status https://zenodo.org/badge/502907107.svg
  • Free software: MIT license

  • Documentation: not yet publicly available.

Documentation

If you just want to check the documentation, it’s currentl being hosted on chardonnay. Just forward it using ssh:

ssh -L 8888:127.0.0.1:8000 yorkgroup@chardonnay.rutgers.edu

And then go to localhost:8888 on your browser.

Install

Clone this repo:

git clone git@github.com:/pgbarletta/amberflow

Change dir into the project and create conda environment:

mamba env create -f conda/dev_environment.yaml

Install this project:

git clone git@github.com:/pgbarletta/amberflow

Build it in editable mode using pip:

pip install -e .

Build the documentation:

sphinx-build -b html docs/source/ docs/build/html/

Access the docs locally on your browser:

PATH/amberflow/docs/build/html/index.html

Development

To release a new version, just tag the main brand and push:

git tag 0.2.8
git push --tags

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

amberflow-0.3.7-py3-none-any.whl (308.2 kB view details)

Uploaded Python 3

File details

Details for the file amberflow-0.3.7-py3-none-any.whl.

File metadata

  • Download URL: amberflow-0.3.7-py3-none-any.whl
  • Upload date:
  • Size: 308.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.31

File hashes

Hashes for amberflow-0.3.7-py3-none-any.whl
Algorithm Hash digest
SHA256 c82269ae34559da067a9ba22309c175d1bb7ce0e17980350250856ba2d4cc427
MD5 efcbe29cbbbcf3412273c8f088b4b957
BLAKE2b-256 feab9e672a75da81e627c8139a75a474deddf0abf70691991841dee831b1afe8

See more details on using hashes here.

Supported by

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