Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RoryBarnes committed Aug 23, 2023
1 parent 2ada4b6 commit 935f7f3
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,27 @@
<h1 align="center">multi-planet: Multi-core Simulations of VPLanet</h1>

<p align="center">
<a href="https://VirtualPlanetaryLaboratory.github.io/multi-planet/"><img src="https://img.shields.io/badge/read-the_docs-blue.svg?style=flat"></a>
<a href="https://VirtualPlanetaryLaboratory.github.io/multi-planet/">
<img src="https://img.shields.io/badge/read-the_docs-blue.svg?style=flat">
</a>
<a href="https://github.com/VirtualPlanetaryLaboratory/multi-planet//actions/workflows/docs.yml">
<img src="https://github.com/VirtualPlanetaryLaboratory/multi-planet//actions/workflows/docs.yml/badge.svg"/>
<img src="https://github.com/VirtualPlanetaryLaboratory/multi-planet//actions/workflows/docs.yml/badge.svg"/>
</a>
<a href="LICENSE">
<img src="https://img.shields.io/badge/license-MIT-purple.svg">
</a>
<a href="https://VirtualPlanetaryLaboratory.github.io/vplanet/conduct.html"><img src="https://img.shields.io/badge/Code%20of-Conduct-7d93c7.svg"></a><br>
<img src="https://img.shields.io/badge/Unit%20Tests-5-darkblue.svg">
</a>
<img src="https://img.shields.io/badge/Python-3.6--3.9-orange.svg"/></a>
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-purple.svg"/></a>
<a href="https://github.com/VirtualPlanetaryLaboratory/multi-planet//actions/workflows/tests.yml">
<img src="https://github.com/VirtualPlanetaryLaboratory/multi-planet//actions/workflows/tests.yml/badge.svg"/>
<a href="https://github.com/VirtualPlanetaryLaboratory/multi-planet//actions/workflows/tests.yml">
<img src="https://github.com/VirtualPlanetaryLaboratory/multi-planet//actions/workflows/tests.yml/badge.svg"/>
</a>
<a href="https://github.com/VirtualPlanetaryLaboratory/multi-planet//actions/workflows/wheels.yml">
<img src="https://github.com/VirtualPlanetaryLaboratory/multi-planet//actions/workflows/wheels.yml/badge.svg"/>
<img src="https://img.shields.io/badge/Python-3.6--3.9-orange.svg"/><br>
<a href="https://github.com/VirtualPlanetaryLaboratory/multi-planet//actions/workflows/pip-install.yml">
<img src="https://github.com/VirtualPlanetaryLaboratory/multi-planet//actions/workflows/pip-install.yml/badge.svg"/>
</a>
<img src="https://img.shields.io/badge/Python-3.7--3.9-orange.svg"/>
<img src = "https://img.shields.io/badge/Platforms-Linux_|%20macOS-darkgreen.svg?style=flat">
</p>

Use `multi-planet` to run a large number of simulations, created with [vspace](https://github.com/VirtualPlanetaryLaboratory/vspace), on one or more cores. The included script `mpstatus` provides the current status of the simulations. Note that `multi-planet` cannot be used to run simulations across multiple computers. [Read the docs](https://VirtualPlanetaryLaboratory.github.io/multi-planet/) to learn how to run your VPLanet parameter sweeps.

0 comments on commit 935f7f3

Please sign in to comment.