Commit 43d2c45a authored by Ashwin V. Mohanan's avatar Ashwin V. Mohanan
Browse files

Document dedalus and modify install from repo

parent 28a193e9edb1
......@@ -17,6 +17,7 @@ __pycache__
.venv/
.pytest_cache/
.mypy_cache/
.coverage/
bench/launcher_*
bench/SLURM*
......@@ -38,7 +39,6 @@ dist/*.tar.gz
dist*
.eggs/*
.tox/*
.coverage/*
*.so
......
......@@ -28,6 +28,8 @@ mock_modules(
(
"basilisk",
"basilisk.stream",
"dedalus",
"dedalus.extras",
"pyshtools",
"pyshtools.constants",
"fluidsht",
......@@ -196,6 +198,43 @@ html_static_path = []
# template names.
# html_additional_pages = {}
# Values to pass into the template engine's context for all pages.
html_context = {
"sidebar_external_links_caption": "Links",
"sidebar_external_links": [
(
'<i class="fa fa-cube fa-fw"></i> PyPI',
f"https://pypi.org/project/{project.lower()}",
),
(
'<i class="fa fa-cube fa-fw"></i> Conda forge',
f"https://anaconda.org/conda-forge/{project.lower()}",
),
(
'<i class="fa fa-code fa-fw"></i> Source code',
f"https://foss.heptapod.net/fluiddyn/{project.lower()}",
),
(
'<i class="fa fa-bug fa-fw"></i> Issue tracker',
f"https://foss.heptapod.net/fluiddyn/{project.lower()}/-/issues",
),
# ('<i class="fa fa-rss fa-fw"></i> Blog', 'https://...'),
(
'<i class="fa fa-comments fa-fw"></i> Chat',
"https://matrix.to/#/#fluiddyn-users:matrix.org",
),
(
'<i class="fa fa-envelope fa-fw"></i> Mailing list',
"https://www.freelists.org/list/fluiddyn",
),
(
'<i class="fa fa-file-text fa-fw"></i> Citation',
"https://doi.org/10.5334/jors.239",
),
],
}
# If false, no module index is generated.
# html_domain_indices = True
......
......@@ -111,6 +111,7 @@ presenting the `FluidDyn project
tutorials
examples
test_bench_profile
faq
Modules Reference
-----------------
......
......@@ -26,6 +26,8 @@ Moreover, fluidfft builds can also be tweaked so you could have a look at
`fluidfft documentation
<http://fluidfft.readthedocs.io/en/latest/install.html>`_.
.. _env_vars:
Environment variables and build configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
......@@ -93,6 +95,8 @@ reinstall an already produced wheel. To do this, use::
``-v`` toggles the verbose mode of pip so that we see the compilation log and
can check that everything goes well.
.. _pythranrc:
About using Pythran to compile functions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
......@@ -181,7 +185,7 @@ Installing from the repository
A good base to install Fluidsim from source can be to create and activate a
conda environment with::
conda create -y -n env-fluidsim -c conda-forge fluidsim "fluidfft=*=*openmpi*" pythran clangdev mako
conda create -y -n env-fluidsim -c conda-forge "fluidfft=*=*openmpi*" pythran clangdev mako
conda activate env-fluidsim
For fluidsim, we use the revision control software Mercurial and the main
......
......@@ -24,5 +24,6 @@ Third party solver interfaces:
:toctree:
basilisk
dedalus
"""
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment