Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rename from arsenic to cinnabar #63

Merged
merged 1 commit into from
Aug 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# How to contribute

We welcome contributions from external contributors, and this document
describes how to merge code changes into this arsenic.
describes how to merge code changes into this cinnabar.

## Getting Started

Expand All @@ -19,7 +19,7 @@ describes how to merge code changes into this arsenic.
[branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/)
with the branch name relating to the feature you are going to add.
* When you are ready for others to examine and comment on your new feature,
navigate to your fork of arsenic on GitHub and open a [pull
navigate to your fork of cinnabar on GitHub and open a [pull
request](https://help.github.com/articles/using-pull-requests/) (PR). Note that
after you launch a PR from one of your fork's branches, all
subsequent commits to that branch will be added to the open pull request
Expand All @@ -29,7 +29,7 @@ describes how to merge code changes into this arsenic.
* If you're providing a new feature, you must add test cases and documentation.
* When the code is ready to go, make sure you run the test suite using pytest.
* When you're ready to be considered for merging, check the "Ready to go"
box on the PR page to let the arsenic devs know that the changes are complete.
box on the PR page to let the cinnabar devs know that the changes are complete.
The code will not be merged until this box is checked, the continuous
integration returns checkmarks,
and multiple core developers give "Approved" reviews.
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ jobs:
- name: Run tests
shell: bash -l {0}
run: |
pytest -v --cov=arsenic --cov-report=xml --cov-report=term --color=yes arsenic/tests/
pytest -v --cov=cinnabar --cov-report=xml --cov-report=term --color=yes cinnabar/tests/
- uses: codecov/codecov-action@v2
with:
files: ./coverage.xml
Expand Down Expand Up @@ -116,9 +116,9 @@ jobs:
- name: Run pylint
shell: bash -l {0}
run: |
pylint arsenic/ --fail-under 6
pylint cinnabar/ --fail-under 6
- name: Run black check
shell: bash -l {0}
if: always()
run: |
black --check -l 99 arsenic/ --exclude arsenic/_version.py
black --check -l 99 cinnabar/ --exclude cinnabar/_version.py
2 changes: 1 addition & 1 deletion .lgtm.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ path_classifiers:
- versioneer.py # Set Versioneer.py to an external "library" (3rd party code)
- devtools/*
generated:
- arsenic/_version.py
- cinnabar/_version.py
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ include LICENSE
include MANIFEST.in
include versioneer.py

graft arsenic
graft cinnabar
global-exclude *.py[cod] __pycache__ *.so
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
arsenic
cinnabar (formerly Arsenic)
==============================
[//]: # (Badges)

[![CI](https://github.com/OpenFreeEnergy/arsenic/actions/workflows/ci.yml/badge.svg)](https://github.com/OpenFreeEnergy/arsenic/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/OpenFreeEnergy/arsenic/branch/main/graph/badge.svg)](https://codecov.io/gh/OpenFreeEnergy/arsenic)
[![Documentation Status](https://readthedocs.org/projects/openff-arsenic/badge/?version=latest)](https://openff-arsenic.readthedocs.io/en/latest/?badge=latest)
[![CI](https://github.com/OpenFreeEnergy/cinnabar/actions/workflows/ci.yml/badge.svg)](https://github.com/OpenFreeEnergy/cinnabar/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/OpenFreeEnergy/cinnabar/branch/main/graph/badge.svg)](https://codecov.io/gh/OpenFreeEnergy/cinnabar)
[![Documentation Status](https://readthedocs.org/projects/openff-cinnabar/badge/?version=latest)](https://openff-cinnabar.readthedocs.io/en/latest/?badge=latest)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6210305.svg)](https://doi.org/10.5281/zenodo.6210305)

# Reporting relative free energy results
Expand All @@ -15,11 +15,11 @@ Solution: package that accepts relative free energy results reliably, which is u

### USAGE

`python arsenic.py example.csv `
`python cinnabar.py example.csv `

### OPTIONS

`python arsenic.py --help`
`python cinnabar.py --help`

### Terminology
D is difference (i.e. relative) while d is variance (i.e. error bar)
Expand Down
2 changes: 1 addition & 1 deletion arsenic/__init__.py → cinnabar/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
arsenic
cinnabar
Report results for free energy simualtions
"""

Expand Down
2 changes: 1 addition & 1 deletion arsenic/_version.py → cinnabar/_version.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ def get_config():
cfg.style = "pep440"
cfg.tag_prefix = ""
cfg.parentdir_prefix = "None"
cfg.versionfile_source = "arsenic/_version.py"
cfg.versionfile_source = "cinnabar/_version.py"
cfg.verbose = False
return cfg

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions arsenic/tests/conftest.py → cinnabar/tests/conftest.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
import pytest
from importlib import resources

from arsenic.wrangle import FEMap
from cinnabar.wrangle import FEMap


@pytest.fixture(scope="session")
def fe_map():
"""FEMap using test csv data"""

with resources.path("arsenic.data", "example.csv") as fn:
with resources.path("cinnabar.data", "example.csv") as fn:
femap = FEMap(fn)

return femap
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
Import tests
"""

import arsenic
import cinnabar
import pytest
import sys


def test_arsenic_imported():
def test_cinnabar_imported():
"""Sample test, will always pass so long as import statement worked"""
assert "arsenic" in sys.modules
assert "cinnabar" in sys.modules
6 changes: 3 additions & 3 deletions arsenic/tests/test_stats.py → cinnabar/tests/test_stats.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

import networkx as nx
import numpy as np
from arsenic import stats
from arsenic.stats import bootstrap_statistic
from cinnabar import stats
from cinnabar.stats import bootstrap_statistic


def test_mle_easy():
Expand Down Expand Up @@ -126,7 +126,7 @@ def test_correlation_positive(fe_map):
"""
Test that the absolute DG plots have the correct signs,
and statistics within reasonable agreement to the example data
in `arsenic/data/example.csv`
in `cinnabar/data/example.csv`
"""

nodes = fe_map.graph.nodes
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion devtools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,5 @@ is installed by looking at the `git` tags and how many commits ahead this versio
\d+.\d+.\d+(?\+\d+-[a-z0-9]+)
```
If the version of this commit is the same as a `git` tag, the installed version is the same as the tag,
e.g. `arsenic-0.1.2`, otherwise it will be appended with `+X` where `X` is the number of commits
e.g. `cinnabar-0.1.2`, otherwise it will be appended with `+X` where `X` is the number of commits
ahead from the last tag, and then `-YYYYYY` where the `Y`'s are replaced with the `git` commit hash.
2 changes: 1 addition & 1 deletion devtools/conda-envs/env.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: arsenic
name: cinnabar
channels:
- conda-forge
dependencies:
Expand Down
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = arsenic
SPHINXPROJ = cinnabar
SOURCEDIR = .
BUILDDIR = _build

Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Compiling arsenic's Documentation
# Compiling cinnabar's Documentation

The docs for this project are built with [Sphinx](http://www.sphinx-doc.org/en/master/).
To compile the docs, first ensure that Sphinx and the ReadTheDocs theme are installed.
Expand Down
8 changes: 4 additions & 4 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ API Documentation
.. autosummary::
:toctree: autosummary

arsenic.plotting
arsenic.plotlying
arsenic.stats
arsenic.wrangle
cinnabar.plotting
cinnabar.plotlying
cinnabar.stats
cinnabar.wrangle
4 changes: 2 additions & 2 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ Release history

This section lists features and improvements of note in each release.

The full release history can be viewed `at the GitHub arsenic releases page <https://github.com/OpenFreeEnergy/arsenic/releases>`_.
The full release history can be viewed `at the GitHub cinnabar releases page <https://github.com/OpenFreeEnergy/cinnabar/releases>`_.

0.2.1 - Release
---------------

Bugfixes
^^^^^^^^
Fix erroneous MLE estimate when self-edges are included (PR `#38 <https://github.com/openforcefield/openff-arsenic/pull/38>`_).
Fix erroneous MLE estimate when self-edges are included (PR `#38 <https://github.com/OpenFreeEnergy/cinnabar/pull/38>`_).
14 changes: 7 additions & 7 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

# -- Project information -----------------------------------------------------

project = "arsenic"
project = "cinnabar"
copyright = (
"2020, Hannah Bruce Macdonald. Project structure based on the "
"Computational Molecular Science Python Cookiecutter version 1.1"
Expand Down Expand Up @@ -117,7 +117,7 @@
# -- Options for HTMLHelp output ---------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = "arsenicdoc"
htmlhelp_basename = "cinnabardoc"


# -- Options for LaTeX output ------------------------------------------------
Expand All @@ -141,15 +141,15 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, "arsenic.tex", "arsenic Documentation", "arsenic", "manual"),
(master_doc, "cinnabar.tex", "cinnabar Documentation", "cinnabar", "manual"),
]


# -- Options for manual page output ------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [(master_doc, "arsenic", "arsenic Documentation", [author], 1)]
man_pages = [(master_doc, "cinnabar", "cinnabar Documentation", [author], 1)]


# -- Options for Texinfo output ----------------------------------------------
Expand All @@ -160,10 +160,10 @@
texinfo_documents = [
(
master_doc,
"arsenic",
"arsenic Documentation",
"cinnabar",
"cinnabar Documentation",
author,
"arsenic",
"cinnabar",
"Report results for free energy simualtions",
"Miscellaneous",
),
Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Getting Started
===============

`arsenic` is a package to aid with the consistent and reliable plotting of results from free energy calculations. Fair assessment and comparison of computational methods relies on robust and reproduceable metrics, which `freeenergy framework` aims to provide.
`cinnabar` is a package to aid with the consistent and reliable plotting of results from free energy calculations. Fair assessment and comparison of computational methods relies on robust and reproduceable metrics, which `freeenergy framework` aims to provide.
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.. arsenic documentation master file, created by
.. cinnabar documentation master file, created by
sphinx-quickstart on Thu Mar 15 13:55:56 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

Welcome to arsenic's documentation!
Welcome to cinnabar's documentation!
=========================================================

.. toctree::
Expand Down
2 changes: 1 addition & 1 deletion docs/make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ if "%SPHINXBUILD%" == "" (
)
set SOURCEDIR=.
set BUILDDIR=_build
set SPHINXPROJ=arsenic
set SPHINXPROJ=cinnabar

if "%1" == "" goto help

Expand Down
6 changes: 3 additions & 3 deletions examples/Untitled.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"%matplotlib inline\n",
"import matplotlib.pylab as plt\n",
"\n",
"from arsenic import plotting, stats"
"from cinnabar import plotting, stats"
]
},
{
Expand Down Expand Up @@ -112,7 +112,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
Expand All @@ -126,7 +126,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.6.8"
"version": "3.10.5"
}
},
"nbformat": 4,
Expand Down
6 changes: 3 additions & 3 deletions examples/first-example.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"%matplotlib inline\n",
"import matplotlib.pylab as plt\n",
"\n",
"from arsenic import plotting, stats, wrangle, absolute"
"from cinnabar import plotting, stats, wrangle, absolute"
]
},
{
Expand Down Expand Up @@ -579,7 +579,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
Expand All @@ -593,7 +593,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.6.8"
"version": "3.10.5"
}
},
"nbformat": 4,
Expand Down
10 changes: 5 additions & 5 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# .coveragerc to control coverage.py and pytest-cov
omit =
# Omit generated versioneer
arsenic/_version.py
cinnabar/_version.py
branch = True

[yapf]
Expand All @@ -21,15 +21,15 @@ max-line-length = 119
# Automatic version numbering scheme
VCS = git
style = pep440
versionfile_source = arsenic/_version.py
versionfile_build = arsenic/_version.py
versionfile_source = cinnabar/_version.py
versionfile_build = cinnabar/_version.py
tag_prefix = ''
parentdir_prefix = arsenic-
parentdir_prefix = cinnabar-

[aliases]
test = pytest

include_package_data = True

[options.package_data]
arsenic = "./arsenic/data/example.csv"
cinnabar = "./cinnabar/data/example.csv"
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
arsenic
cinnabar

Report results for free energy simulations.
"""
Expand All @@ -21,7 +21,7 @@

setup(
# Self-descriptive entries which should always be present
name='arsenic',
name='cinnabar',
author='Open Free Energy',
author_email='hannah.brucemacdonald@choderalab.org',
description=short_description[0],
Expand Down