Skip to content

Commit 79f7e12

Browse files
authored
Fix: Docs (#551)
* fix: prioritized the use of subordinate metadata when choosing between feature level and subordinate level * fix: revisions to SmartPeak GUI section * feat: added a starting point for the server section * wip: revising and expanding features * fix: updated version for installation instructions * wip: revising and expanding features * fix/feat: update faqs * fix: removed paramters now that it is redundant with the faqs * feat: updated FAQ section * fix: small changes to start and server pages * feat: added images and descriptions to missing FAQ sections * feat: added images and descriptions to missing FAQ sections * fix: revised select features from best dilution section of features * fix/feat: updated audit trail in features; fixed a couple of bugs found when building the docs * fix: other bugs found after building the docs * feat: updates to features audit trail section * feat: updates to features audit trail section * fix: edited HPLC tutorial page * wip: adding LC-MS/MS-SRM tutorial * feat, wip: added DDA and DIA tutorials * fix: revisions to FIAMS tutorial * fix: table reformatting * wip: fixing tables in tutorials... * wip: fixing tables in tutorials... * fix: removed instrument specifics in tutorial names * fix: broken tables in the tutorials * feat: updated all tutorial acquisition schematics * feat: added additional sections for features * fix: bug in server usage section * fix: updated documentation for the server to include dockerhub images * fix: updated features to include a section on workflow steps * wip: updating optimize calibration curve usage and example * feat: added new screenshots for features * fix: bugs in features * feat: optimize calibration curves feature section * wip: added screenshots for lcms-srm tutorial * feat: body for lcms-srm tutorial * wip: adding dda methods * wip: workflows for DDA workflows * feat: added dda tutorial body * feat: dda tutorial screenshots * fix: bugs in lcms dda tutorial * fix: bugs in tables in dda tutorial * fix, feat: preparing for PR and small bug fixes
1 parent d84f890 commit 79f7e12

File tree

63 files changed

+3766
-2956
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+3766
-2956
lines changed

docs/about/parameters.rst

Lines changed: 0 additions & 279 deletions
This file was deleted.

docs/faq.rst

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/guide/guistart.rst renamed to docs/guide/gui.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Using SmartPeak GUI
44
----------------------------------------------------------------------------------------------------------
55

6-
After successful installation of SmartPeak, on Windows open menu start and browse for relevant icon, you can also find the shortcut on desktop.
6+
This page describes the graphical user interface (GUI) for working with SmartPeak. SmartPeak GUI provides functionality to facilitate users to get up and running as quickly as possible. SmartPeak GUI also provides various graphical views and plots to enable faster debugging and configuration of workflows and algorithms. After installation of SmartPeak on Windows, MacOS, and/or Linux, a shortcut should be available for quickly launching the application.
77

88
.. _logs:
99

docs/guide/install.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ Example on Ubuntu
99

1010
.. code-block:: bash
1111
12-
wget https://github.com/AutoFlowResearch/SmartPeak/releases/download/v1.2.0/SmartPeak-1.2.0-Linux.deb
13-
sudo dpkg -i SmartPeak-1.2.0-Linux.deb
12+
wget https://github.com/AutoFlowResearch/SmartPeak/releases/download/v1.26.0/SmartPeak-1.26.0-Linux.deb
13+
sudo dpkg -i SmartPeak-1.26.0-Linux.deb
1414
sudo apt-get install -f
1515
16-
User can also use GUI by double clicking on SmartPeak-1.2.0-Linux.deb icon and requesting installation through Ubuntu Software.
16+
User can also use GUI by double clicking on SmartPeak-1.26.0-Linux.deb icon and requesting installation through Ubuntu Software.
1717

1818

1919
Example on Windows
2020
------------------
2121

22-
Download latest release for windows, e.g. ``SmartPeak-1.2.0-win64.exe`` and double click on the icon.
22+
Download latest release for windows, e.g. ``SmartPeak-1.26.0-win64.exe`` and double click on the icon.
2323
The wizard will guide you through the installation process.
2424

2525
A warning from Windows Defender SmartScreen may appear.

docs/guide/server.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. begin_smartpeak_server_usage
2+
3+
Using SmartPeak Server
4+
----------------------------------------------------------------------------------------------------------
5+
6+
This page describes the remote server for scaling SmartPeak to large and computationally demanding workflows using high performance computing (HPC) resources.
7+
The SmartPeak Server utilizes containerization and gRPC to enable users to connect, control, and view a remote session using the SmartPeak GUI.
8+
An IT administrator would most likely be required to set-up the remote server on the HPC resources and ensure file transfer and security are in place.
9+
The SmartPeak team maintains containerized versions of the SmartPeak `CLI <https://hub.docker.com/r/autoflowresearch/smartpeak-cli>`_ and `Server <https://hub.docker.com/r/autoflowresearch/smartpeak-server>`_ on DockerHub that are required for setting up the workers and server, respectively.
10+
11+
.. todo::
12+
Describe the functionality of the SmartPeak Server.
13+
14+
.. todo::
15+
Describe how to set-up the SmartPeak Server as an IT administrator.
16+
17+
.. todo::
18+
Describe how to connect to the SmartPeak Server as a user.
19+
20+
.. warning::
21+
SmartPeak Server is currently experimental!
22+
23+
.. end_smartpeak_server_usage

docs/guide/tutorials.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,20 @@
11
Tutorials & Demos
22
=============================================================================
33

4-
This section covers a breadth of walkthroughs using different datasets and analytical techniques.
4+
This section covers a breadth of walkthroughs using different datasets and analytical techniques.
5+
All of the datasets used in the tutorials can be found on `GitHub <https://github.com/AutoFlowResearch/SmartPeak/tree/develop/src/examples/data>`_.
6+
The datasets and input files can be used as templates for getting started with a new and similar workflow in SmartPeak.
57

8+
* :doc:`tutorials/Targeted_quantitation_with_LC-MSMS_5500_QTRAP_RapidRIP`.
69

710
* :doc:`tutorials/Targeted_quantitation_with_HPLC_data`.
811

912
* :doc:`tutorials/Non-targeted_FIA-MS_analysis_with_Thermo_Orbitrap`.
1013

14+
* :doc:`tutorials/Non-targeted_LC-MSMS_DDA_analysis_with_Thermo_Orbitrap`.
15+
16+
* :doc:`tutorials/Non-targeted_LC-MSMS_DIA_analysis`.
17+
1118
* :doc:`tutorials/Targeted_flux_analysis_with_LC-MSMS_Agilent_Lipidomics`.
1219

1320
* :doc:`tutorials/Targeted_flux_analysis_with_GC-MS_SIM_Agilent`.

0 commit comments

Comments
 (0)