From 2d1e0aa4bbffe0faef21c48ffd50b7c2bfe2fadb Mon Sep 17 00:00:00 2001 From: Andrew McCluskey Date: Thu, 23 Apr 2020 13:02:55 +0100 Subject: [PATCH] moredocs --- docs/source/index.rst | 4 +-- docs/source/installation.rst | 2 +- docs/source/vertical_geometry.ipynb | 39 +++++++++++++++++++++++++++++ docs/source/workflows.rst | 2 +- 4 files changed, 43 insertions(+), 4 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index c0a1e9f..ffee58a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,8 +6,8 @@ X-ray reflectometry reduction in Python ======================================= -``islatu`` is an open-source pacakge for the reduction of x-ray reflectometry datasets. -Currently, ``islatu`` is developed at and supports data from `Diamond Light Source`_, however we are happy to work with others to enable data from other sources (including neutron sources). +:py:mod:`islatu` is an open-source pacakge for the reduction of x-ray reflectometry datasets. +Currently, :py:mod:`islatu` is developed at and supports data from `Diamond Light Source`_, however we are happy to work with others to enable data from other sources (including neutron sources). These webpages include `API-level documentation`_ and information about some `workflows`_ that can be used for data reduction. diff --git a/docs/source/installation.rst b/docs/source/installation.rst index e43d0ec..6c90aa3 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -1,7 +1,7 @@ Installation ============ -``islatu`` can be installed from the PyPI package manager with ``pip``: +:py:mod:`islatu` can be installed from the PyPI package manager with :py:mod:`pip`: .. code-block:: bash diff --git a/docs/source/vertical_geometry.ipynb b/docs/source/vertical_geometry.ipynb index c55aee2..eadd77c 100644 --- a/docs/source/vertical_geometry.ipynb +++ b/docs/source/vertical_geometry.ipynb @@ -9,6 +9,45 @@ "This workflow details how to reduce experimental data collected at the I07 beamline, when the sample is a vertical geometry (when the DCD setup is not being used)." ] }, + { + "cell_type": "code", + "execution_count": 37, + "metadata": {}, + "outputs": [], + "source": [ + "from pint import UnitRegistry as UREG" + ] + }, + { + "cell_type": "code", + "execution_count": 39, + "metadata": {}, + "outputs": [], + "source": [ + "import pint\n", + "ureg = pint.UnitRegistry()" + ] + }, + { + "cell_type": "code", + "execution_count": 41, + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "pint.unit.build_unit_class..Unit" + ] + }, + "execution_count": 41, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "type(ureg.meter)" + ] + }, { "cell_type": "code", "execution_count": 1, diff --git a/docs/source/workflows.rst b/docs/source/workflows.rst index e784867..3e2c336 100644 --- a/docs/source/workflows.rst +++ b/docs/source/workflows.rst @@ -1,7 +1,7 @@ Reduction workflows =================== -Some typical data reduction workflows, that ``islatu`` can handle are shown here: +Some typical data reduction workflows, that :py:mod:`islatu` can handle are shown here: .. toctree:: :maxdepth: 1