diff --git a/doc/conf.py b/doc/conf.py index 690267d2215f002dfad665781adbbde3af29a63b..5f26a699e1ed6b24f67a2f99192aa160dc419dcd 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -26,7 +26,7 @@ for file in os.listdir('.'): notebooks = os.listdir('../tutorials') -to_import = ['bvpy_tutorial_domain.ipynb'] +to_import = ['bvpy_tutorial_domain.ipynb', 'bvpy_tutorial_3_poissonEquation_FEniCSlike.ipynb'] for i in notebooks: if '.' != i[0] and i in to_import: diff --git a/doc/index.rst b/doc/index.rst index a5254818d5d2e326969c6f7d3474c8b54d60c05d..776df7617b20375bffb82fbe5f69870d88203d69 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,16 +1,71 @@ -Welcome to bvpy's documentation! -==================================================== +.. include:: substitutions.txt + +======================== +bvpy +======================== + +.. image:: https://gitlab.inria.fr/mosaic/work-in-progress/bvpy/badges/develop/coverage.svg + :target: https://gitlab.inria.fr/mosaic/work-in-progress/bvpy + +.. image:: https://gitlab.inria.fr/mosaic/work-in-progress/bvpy/badges/develop/pipeline.svg + :target: https://gitlab.inria.fr/mosaic/work-in-progress/bvpy/pipelines + .. toctree:: - :caption: Developper's documentation - :maxdepth: 4 + :caption: Table of contents + :maxdepth: 2 + :hidden: Sources <_dvlpt/modules> report notebook -Indices and tables -================== -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +Package providing tools to solve BVP (Boundary Value Problem) and IVP (Initial Value Problem). + +It rely on `FEniCS <https://fenicsproject.org/>`_ finite element library and `GMSH <http://gmsh.info/>`_. + +.. sidebar:: |name| + + :Coordination: |coord| + + :Contributors: |contrib| + + :Active teams: Inria project-team `Mosaic <https://team.inria.fr/mosaic/>`_ + + :Stable release: |release| + + :Written in: Python + + :Supported OS: Linux, Mac OS + :Licence: `CeCILL-C licence <https://cecill.info/licences/Licence_CeCILL-C_V1-en.html>`_ + + +Requirements +------------ + +* Python 3.6+ +* FEniCS +* GMSH + + +Installation +------------ + +* From sources: + +.. code-block:: bash + + python setup.py develop + + +* On `Anaconda Cloud <https://anaconda.org/mosaic/femtk>`_: + +.. code-block:: bash + + conda install -c mosaic -c conda-forge bvpy + + +Examples +-------- + +You can find introduction for ``bvpy`` :ref:`here<tutorial_example>` diff --git a/doc/notebook.rst b/doc/notebook.rst index 9a4af41c90b1bf44a1037ce83692ce3ed30bd2f6..c7949448ae8e87469110c59ef9d8222c0429b912 100644 --- a/doc/notebook.rst +++ b/doc/notebook.rst @@ -1,10 +1,11 @@ -.. _problem_example: +.. _tutorial_example: -Problems -******** +Tutorials +********* .. toctree:: :titlesonly: :maxdepth: 1 bvpy_tutorial_domain + bvpy_tutorial_3_poissonEquation_FEniCSlike diff --git a/doc/substitutions.txt b/doc/substitutions.txt new file mode 100644 index 0000000000000000000000000000000000000000..f1de211053357ea55877d0a49e40a92389e4e6a4 --- /dev/null +++ b/doc/substitutions.txt @@ -0,0 +1,5 @@ +.. |coord| replace:: Florian Gacon, Olivier Ali +.. |contrib| replace:: Christophe Godin +.. |licence| replace:: Cecill-C +.. |name| replace:: bvpy +.. |gitlab_url| replace:: git@gitlab.inria.fr:mosaic/work-in-progress/femtk.git diff --git a/src/bvpy/bvp.py b/src/bvpy/bvp.py index 4a172963ad01e3e7e50c55e0b3272897c59d2e8d..e731e16cddd3c9ea7bf48b796fe5c817f5a31c61 100644 --- a/src/bvpy/bvp.py +++ b/src/bvpy/bvp.py @@ -161,18 +161,14 @@ class BVP(object): method='topological', subspace=None, degree=None): - """Add a boundary condition to the problem (Dirichlet or Neumann). + """Add a boundary condition to the problem (Dirichlet). Parameters ---------- bnd_cond : :class:`ConstantDirichlet<femtk.boundary_conditions. dirichlet.ConstantDirichlet>`, :class:`VariableDirichlet<femtk.boundary_conditions. - dirichlet.VariableDirichlet>`, - :class:`ConstantNeumann<femtk.boundary_conditions. - neumann.ConstantNeumann>` or - :class:`VariableNeumann<femtk.boundary_conditions. - neumann.VariableNeumann>` + dirichlet.VariableDirichlet>` Class representing a boundary condition method : str Method to apply Dirichlet condition @@ -180,9 +176,7 @@ class BVP(object): Index of the subspace to constrain for Dirichlet (optional) degree : int Optional argument to determine the degree for - :class:`VariableNeumann<femtk.boundary_conditions. - neumann.VariableNeumann>` - and :class:`VariableDirichlet<femtk.boundary_conditions. + :class:`VariableDirichlet<femtk.boundary_conditions. dirichlet.VariableDirichlet>` Returns