Skip to content

Commit

Permalink
Deploying to pdoc from @ facf954 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
slayoo committed Nov 12, 2024
1 parent 6b13e9c commit 7c6a92d
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 9 deletions.
4 changes: 2 additions & 2 deletions PyMPDATA/solver.html
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,7 @@ <h1 class="modulename">
<div id="PostStepNull.class_type" class="classattr">
<div class="attr variable">
<span class="name">class_type</span> =
<span class="default_value">jitclass.PostStepNull#7f155a4b5ee0&lt;&gt;</span>
<span class="default_value">jitclass.PostStepNull#7f39a55e7820&lt;&gt;</span>


</div>
Expand Down Expand Up @@ -395,7 +395,7 @@ <h1 class="modulename">
<div id="PostIterNull.class_type" class="classattr">
<div class="attr variable">
<span class="name">class_type</span> =
<span class="default_value">jitclass.PostIterNull#7f1552fff520&lt;&gt;</span>
<span class="default_value">jitclass.PostIterNull#7f39a5595a00&lt;&gt;</span>


</div>
Expand Down
45 changes: 39 additions & 6 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,8 @@ <h2>What is PyMPDATA?</h2>
with optional coordinate transformations.
</p>
<p>
A separate project called <b>PyMPDATA-MPI</b> depicts how <b>numba-mpi</b> can be used to enable <b>distributed memory parallelism</b> in PyMPDATA.
A separate project called <b><a href="https://github.com/open-atmos/PyMPDATA-MPI">PyMPDATA-MPI</a></b> depicts how
<b><a href="https://github.com/numba-mpi/numba-mpi">numba-mpi</a></b> can be used to enable <mark>distributed memory parallelism</mark> in PyMPDATA.
</p>
</div>
<div style="padding-top: 0.5em">
Expand Down Expand Up @@ -138,15 +139,25 @@ <h2>Installation</h2>
PyMPDATA is available on PyPI and can be installed using pip:
</p>
<pre><code>pip install PyMPDATA</code></pre>
<p>Note: the way above <b>will not</b> install PyMPDATA-examples, to install them both you can run:</p>
<pre><code>pip install PyMPDATA[tests]</code></pre>
<br>
<p>Note: the way above <b>will not</b> install PyMPDATA-examples, to install them, and run the tests, likely the most convenient way is:</p>
<pre><code>git clone https://github.com/open-atmos/PySDM.git
pip install -e PyMPDATA[tests] -e PyMPDATA/examples[tests]
pytest PyMPDATA
</code></pre>
<p>(the above should be a viable way to set up development environment for PyMPDATA, see also our <a href="https://github.com/open-atmos/python-dev-hints/wiki">Python dev hints Wiki</a> for further information)</p>
<p>
PyMPDATA-examples is available on PyPI and can be installed using pip:
</p>
<pre><code>pip install PyMPDATA-examples</code></pre>
<p>Note: this will also install PyMPDATA</p>
</div>
<p>Note: this will also install PyMPDATA if needed, but the examples package wheels do not include the Jupyter notebooks - only common code used from the notebooks.
All PyMPDATA example notebooks can be viewed on GitHub and feature header cells with badges enabling single-click execution on either
<a href="https://colab.research.google.com">Google Colab</a> or <a href="https://mybinder.org">mybinder.org</a> platforms.
To try the notebooks out locally, use:
</p>
<pre><code>git clone https://github.com/open-atmos/PyMPDATA.git
pip install -e PyMPDATA -e PyMPDATA/examples
jupyter-notebook PyMPDATA/examples</code></pre>
</div>
<div style="padding-top: 0.5em">
<h2>Dependencies</h2>
<p>
Expand Down Expand Up @@ -174,6 +185,28 @@ <h2>Contributing, reporting issues and seeking support</h2>
feature (rather than the issue tracker) for seeking support in understanding,
using and extending PyMPDATA code.
</p>
</div>
<div style="padding-top: 0.5em">
<h2>Licensing, credits, acknowledgements</h2>
<p>
PyMPDATA and PyMPDATA-examples are free/libre open-source software packages released under the
<a href="https://www.gnu.org/licenses/gpl-3.0.en.html">GNU GPL v3 license</a>.
<p>
Development of PyMPDATA was started by <a href="https://github.com/piotrbartman">Piotr Bartman[-Szwarc]</a>,
<a href="https://github.com/slayoo">Sylwester Arabas</a> and collaborators
at the <a href="https://en.uj.edu.pl/en">Jagiellonian University in Kraków</a>.
For an overview of features of the initial release, see the
<a href="https://doi.org/10.21105/joss.03896">2022 PyMPDATA v1 JOSS paper</a>.
See <a href="https://github.com/open-atmos/PyMPDATA/graphs/contributors">list of code committers</a>
for a complete list of contributors.
</p>
<p>
Development of PySDM was supported by:
<ul>
<li><a href="https://www.fnp.org.pl/en/">Foundation for Polish Science</a> (grant no. POIR.04.04.00-00-5E1C/18 co-financed by the European Union under the European Regional Development Fund)</li>
<li><a href="https://ncn.gov.pl/en">Polish National Science Centre</a> (grant no. 2020/39/D/ST10/01220)</li>
</ul>
</p>
</div>
</main>
<script>
Expand Down
Loading

0 comments on commit 7c6a92d

Please sign in to comment.