Skip to content

reactivate status badge #592

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.

Sign up for GitHub

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

Open
mosc9575 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

reactivate status badge #592

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
50b97b8
reactivate status badge and fix minor issues in readme.md
mosc9575 Dec 2, 2025
21a391f
Update and rename README.rst to README.md
mosc9575 Dec 2, 2025
a730ad8
Change enumeration
mosc9575 Dec 2, 2025
95a7510
Rename README.rst to README.MD in setup.py
mosc9575 Dec 2, 2025
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
15 changes: 7 additions & 8 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,12 @@ mpi-sppy
Optimization under uncertainty for `Pyomo <https://pyomo.org>`_ models.

`Documentation is available at readthedocs <https://mpi-sppy.readthedocs.io/en/latest/>`_ and
a there is a `paper <https://link.springer.com/article/10.1007/s12532-023-00247-3>`_
there is a `paper <https://link.springer.com/article/10.1007/s12532-023-00247-3>`_.

Status for internal tests
^^^^^^^^^^^^^^^^^^^^^^^^^

.. image:: https://github.com/Pyomo/mpi-sppy/workflows/pyotracker/badge.svg
:target: https://github.com/Pyomo/mpi-sppy/actions/workflows/pyotracker.yml
[![pyo tracker](https://github.com/Pyomo/mpi-sppy/actions/workflows/pyotracker.yml/badge.svg)](https://github.com/Pyomo/mpi-sppy/actions/workflows/pyotracker.yml)


MPI
Expand All @@ -22,13 +21,13 @@ Here are two methods that seem to work well for installation, at least when cons

#. Install OpenMPI and mpi4py using conda.

* ``conda install openmpi; conda install mpi4py`` (in that order)
* ``conda install openmpi; conda install mpi4py`` (in that order)

#. If you already have an existing version of MPI, it may be better compile mpi4py against it. This can be done by installing mpi4py though pip.

* ``pip install mpi4py``

#. It is also possible to automate mpi4py installation through pip as an optional dependency when installing mpi-sppy from pip or from source by adding the `[mpi]` extras flag.
#. It is also possible to automate mpi4py installation through pip as an optional dependency when installing mpi-sppy from pip or from source by adding the `[mpi]` extras flag.

* ``pip install -e .[mpi]`` (after cloning and moving to the repo root directory)

Expand All @@ -48,7 +47,7 @@ Installing mpi-sppy
^^^^^^^^^^^^^^^^^^^

It is possible to pip install mpi-sppy; however, most users are better off
getting the software from github because it is under active development.
getting the software from Github because it is under active development.

Citing mpi-sppy
^^^^^^^^^^^^^^^
Expand All @@ -58,7 +57,7 @@ If you find mpi-sppy useful in your work, we kindly request that you cite the fo

@article{mpi-sppy,
title={A Parallel Hub-and-Spoke System for Large-Scale Scenario-Based Optimization Under Uncertainty},
author={Bernard Knueven and David Mildebrath and Christopher Muir and John D Siirola and Jean-Paul Watson and David L Woodruff},
author={Bernard Knueven and David Mildebrath and Christopher Muir and John D Siirola and Jean-Paul Watson and David L Woodruff},
journal = {Math. Prog. Comp.},
volume = {15},
pages = {591-–619},
Expand Down
Loading