Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/source/examples/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ Example notebooks
Several examples available in the pyobjcryst repository:

:doc:`3D Crystal structure display <crystal_3d_widget>`
================================================================
=======================================================

Example of importing a CIF file from a file or the
`Crystallography Open Database <http://crystallography.net/cod/>`_
and displaying it in a widget using
`3dmol.js <https://3dmol.csb.pitt.edu/>`_.

:doc:`Solving the cimetidine structure from its powder pattern <structure-solution-powder-cimetidine>`
===============================================================================================================
======================================================================================================

In this example, a powder pattern is used to solve the crystal
structure of Cimetidine. This covers all the steps: loading the
Expand All @@ -22,7 +22,7 @@ the spacegroup, profile fitting, and solving the structure
using a global optimisation algorithm.

:doc:`Solving the PbSO4 structure from its X and N powder patterns <structure-solution-powder-pbso4>`
==============================================================================================================
=====================================================================================================

In this example, two powder patterns (X-ray and neutron) are used to solve
the crystal structure of PbSO4. This covers all the steps: loading the
Expand All @@ -31,14 +31,14 @@ the spacegroup, profile fitting for the two patterns, and solving the
structure using a global optimisation algorithm.

:doc:`Meta-structure solution using multi-processing <structure-solution-multiprocessing>`
===================================================================================================
==========================================================================================

This is a more advanced example where 8 different spacegroups are
tested in parallel to determine which one is correct. The solutions
can then be compared and displayed individually.

:doc:`Quantitative phase analysis (QPA) <Quantitative-phase-analysis>`
===============================================================================
:doc:`Quantitative phase analysis (QPA) <QPA-Quantitative phase analysis>`
==========================================================================

Example of QPA based on the data available from the `1999 Round Robin
<https://www.iucr.org/__data/iucr/powder/QARR/samples.htm>`_,
Expand Down
79 changes: 0 additions & 79 deletions docs/source/getting-started.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,6 @@
| Software version |release|
| Last updated |today|.

===============
Getting started
===============

Welcome to the ``pyobjcryst`` documentation!

To get started, please visit the :ref:`Getting started <getting-started>` page.

=======
Authors
=======
Expand Down
23 changes: 23 additions & 0 deletions news/remove-template.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* No news added: Remove the documentation template and add QPA notebook in documentation.

**Changed:**

* <news item>

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>
Loading