Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make headers GPL compliant and removed __pkginfo__ #397

Merged
merged 14 commits into from
Mar 28, 2024
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 3 additions & 3 deletions Doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@
# project = 'MDANSE'
# copyright = '2015-2022, Eric Pellegrini'
author = 'Eric Pellegrini'
release = '1.5.2'
version = '1.5'
release = '2.0.0a1'
version = '2.0'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
Expand Down Expand Up @@ -86,7 +86,7 @@
current_year = datetime.date.today().year
# General information about the project.
project = u'MDANSE'
copyright = u'2015-' + str(current_year) + u', MDANSE is developed and supported by the Institut Laue-Langevin and the ISIS Neutron and Muon Source', '![UKRI Logo](_static/UKRI_Logo.png)'
copyright = u'2015-' + str(current_year) + u', MDANSE is developed and supported by the Institut Laue-Langevin and the ISIS Neutron and Muon Source, ![UKRI Logo](_static/UKRI_Logo.png)'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down
17 changes: 5 additions & 12 deletions Doc/pages/T_start.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Tutorial: Get started (Installation)
====================================

.. _installation_tutorial:

MDANSE Installation Steps
--------------------------

Expand Down Expand Up @@ -42,7 +44,7 @@ activation command varies by operating system:

- On Windows:

.. code-block:: bash
.. code-block:: console

mdanse\Scripts\activate

Expand All @@ -53,7 +55,7 @@ Use `pip` to install the MDANSE package from the specified GitHub repository:

.. code-block:: bash

python -m pip install "git+https://github.com/ISISNeutronMuon/MDANSE@protos#egg=MDANSE&subdirectory=MDANSE"
pip install MDANSE

Install MDANSE_GUI Package
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -62,16 +64,7 @@ Similarly, install the MDANSE_GUI package using `pip`:

.. code-block:: bash

python -m pip install "git+https://github.com/ISISNeutronMuon/MDANSE@protos#egg=MDANSE_GUI&subdirectory=MDANSE_GUI"

Install PyQt6
~~~~~~~~~~~~~

MDANSE relies on PyQt6, a Python binding for the Qt library. Install it using `pip`:

.. code-block:: bash

pip install PyQt6
pip install MDANSE_GUI

Run MDANSE
~~~~~~~~~~
Expand Down
37 changes: 3 additions & 34 deletions Doc/pages/files.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,10 @@ HDF5 format using the Trajectory Converter tool.
DAT File Format
-----------------

During an Analysis in MDANSE, the default output format is now `DAT files <https://en.wikipedia.org/wiki/DAT_file>`_, which
An alternative output format of Analysis results is in the form of
`DAT files <https://en.wikipedia.org/wiki/DAT_file>`_, which
are text-based and easily readable. Each DAT file corresponds to a specific
variable generated during the analysis. If the ASCII option is selected, a
variable generated during the analysis. If the Text option is selected, a
tarball is generated, which contains multiple files, including:

- ``jobinfo.txt``: A text file documenting the analysis options selected during
Expand Down Expand Up @@ -68,35 +69,3 @@ repetitive tasks and ensuring consistency in analysis procedures.
This update streamlines the analysis process and facilitates the reproducibility
of results within MDANSE.

.. _convert_netcdf:

NetCDF to HDF5 Conversion Script
---------------------------------------

MDANSE now provides a versatile Python script that simplifies the process
of converting existing NetCDF files to the HDF5 format. This script is especially
valuable for users with legacy data stored in NetCDF files who wish to take
advantage of the enhanced capabilities and compatibility offered by MDANSE's
shift to HDF5.

To perform the conversion, follow these steps:

1. Open a terminal or command prompt.
2. Navigate to the directory containing the NetCDF files you want to convert.
3. Run the following command, replacing [input_file.nc] with the name of your
NetCDF file and [output_file.h5] with your desired name for the resulting
HDF5 file::

.. code-block:: bash

python convert_netcdf_to_hdf5.py [input_file.nc] [output_file.h5]

This command will execute the conversion script and generate an HDF5 file
with the specified name.

4. Once the conversion is complete, you can use the newly created HDF5 file
seamlessly within MDANSE for advanced analysis and visualization.

This convenient script streamlines the migration of existing data to the HDF5
format, ensuring that users can leverage MDANSE's enhanced features while
preserving their valuable data.
Loading
Loading