Skip to content

Commit

Permalink
Merge pull request #152 from pcubillos/packaging
Browse files Browse the repository at this point in the history
Packaging
  • Loading branch information
pcubillos authored May 30, 2024
2 parents d4ac71f + e8c0f5e commit 4a58c12
Show file tree
Hide file tree
Showing 11 changed files with 57 additions and 554 deletions.
9 changes: 3 additions & 6 deletions .github/workflows/python-package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,13 @@ jobs:
strategy:
fail-fast: false
matrix:
python-version: ["3.7", "3.8", "3.9", "3.10"]
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
os: [ubuntu-latest]
include:
- python-version: "3.6"
os: ubuntu-20.04

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v3
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
Expand Down
21 changes: 8 additions & 13 deletions docs/get_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,8 @@ Getting Started
System Requirements
-------------------

``mc3`` is compatible with Python 3.6+, and has been `tested
<https://github.com/pcubillos/mc3/actions/workflows/python-package.yml>`_ to work on Unix/Linux and
OS X machines, with the following software:

* Numpy >= 1.19.5
* Scipy >= 1.9.3
* Matplotlib >= 3.3.4

``mc3`` may work with previous versions of these software;
however, we do not guarantee nor provide support for that.

``mc3`` is compatible with Python 3.7+, and has been `tested
<https://github.com/pcubillos/mc3/actions/workflows/python-package.yml>`_ to work on Unix/Linux and OS X machines.

Install
-------
Expand All @@ -39,10 +30,11 @@ Alternatively (e.g., for developers), clone the repository to your local machine
git clone https://github.com/pcubillos/mc3
cd mc3
pip install -r requirements.txt
pip install -e .
``mc3`` provides MCMC and nested-sampling posterior sampling,
``mc3`` provides MCMC posterior sampling,
optimization and other lower-level statistical and plotting
routines. See the full docs in the :ref:`api` or through the Python
interpreter:
Expand All @@ -52,10 +44,13 @@ interpreter:
import mc3
# Bayesian posterior sampling:
help(mc3.sample)
# Optimization:
help(mc3.fit)
# Assorted stats:
# Assorted stats utilities:
help(mc3.stats)
# Plotting utilities:
help(mc3.plots)
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ mc3: Multi-Core Markov-Chain Monte Carlo

.. note::

Got Python3.6+? Simply install as: ``pip install mc3``
Got Python3.7+? Simply install as: ``pip install mc3``


Features
Expand Down
77 changes: 0 additions & 77 deletions examples/ns_tutorial.py

This file was deleted.

5 changes: 2 additions & 3 deletions mc3/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@
import argparse
import configparser

import matplotlib as mpl
if os.environ.get('DISPLAY', '') == '':
mpl.use('Agg')
import matplotlib
import matplotlib.pyplot as plt

import mc3
Expand Down Expand Up @@ -236,6 +234,7 @@ def parse():


if __name__ == "__main__":
matplotlib.use('Agg')
plt.ioff()
warnings.simplefilter("ignore", RuntimeWarning)
main()
216 changes: 0 additions & 216 deletions mc3/ns_driver.py

This file was deleted.

Loading

0 comments on commit 4a58c12

Please sign in to comment.