Skip to content

Commit

Permalink
moredocs
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrew McCluskey committed Apr 23, 2020
1 parent 8bde925 commit 2d1e0aa
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/installation.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down
39 changes: 39 additions & 0 deletions docs/source/vertical_geometry.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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.<locals>.Unit"
]
},
"execution_count": 41,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"type(ureg.meter)"
]
},
{
"cell_type": "code",
"execution_count": 1,
Expand Down
2 changes: 1 addition & 1 deletion docs/source/workflows.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 2d1e0aa

Please sign in to comment.