Skip to content

Commit ee1cc9f

Browse files
authored
Docs: Enhancements to Installation, Introduction, and Tutorial Sections (aiidateam#6806)
Fixes several typos, and formatting problem. Some of the links were not even shown properly.
1 parent 61be15d commit ee1cc9f

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

docs/source/installation/docker.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Any data that was created in a previous session is still available.
7777

7878
.. caution::
7979

80-
When the container is not just stopped but *deleted*, any data stored in the container, including the data stored in the profile's storage, is permanently localhost
80+
When the container is not just stopped but *deleted*, any data stored in the container, including the data stored in the profile's storage, is permanently deleted.
8181
To ensure the data is not lost, it should be persisted on a volume that is mounted to the container.
8282
Refer to the section on :ref:`persisting data <installation:docker:persisting-data>` for more details.
8383

docs/source/installation/guide_complete.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ Although it is possible to run AiiDA without a daemon it does provide significan
157157

158158
.. tab-item:: MacOS X
159159

160-
#. Install `Homebrew <https://docs.brew.sh/Installation>`.
160+
#. Install `Homebrew <https://docs.brew.sh/Installation>`__.
161161

162162
#. Install RabbitMQ:
163163

@@ -315,7 +315,7 @@ The options specific to the ``core.sqlite_dos`` storage plugin are:
315315
This storage plugin uses `PostgreSQL <https://www.postgresql.org/>`_ and the `disk-objectstore <https://disk-objectstore.readthedocs.io/en/latest/>`_ to store data.
316316
The ``disk-objectstore`` is a Python package that is automatically installed as a dependency when installing ``aiida-core``, which was covered in the :ref:`Python package installation section <installation:guide-complete:python-package>`.
317317
The storage plugin can connect to a PostgreSQL instance running on the localhost or on a server that can be reached over the internet.
318-
Instructions for installing PostgreSQL is beyond the scope of this guide.
318+
Instructions for installing PostgreSQL is beyond the scope of this guide. You can find the installation instructions for your system on the `PostgreSQL website <https://www.postgresql.org/docs/current/tutorial-install.html>`__.
319319

320320
Before creating a profile, a database (and optionally a custom database user) has to be created.
321321
First, connect to PostgreSQL using ``psql``, the `native command line client for PostgreSQL <https://www.postgresql.org/docs/current/app-psql.html>`_:

docs/source/intro/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ Introduction
1010

1111
AiiDA is an open-source Python infrastructure to help researchers with automating, managing, persisting, sharing and reproducing the complex workflows associated with modern computational science and all associated data.
1212

13-
AiiDA is built to support and streamline the four core pillars of the ADES model: Automation, Data, Environment, and Sharing (described `here <https://arxiv.org/abs/1504.01163>`__). Some of the key features of AiiDA include:
13+
AiiDA is built to support and streamline the four core pillars of the ADES model: Automation, Data, Environment, and Sharing (described `here <https://arxiv.org/abs/1504.01163>`__, `doi <https://doi.org/10.1016/j.commatsci.2015.09.013>`__). Some of the key features of AiiDA include:
1414

1515
* **Workflows:** AiiDA allows to build and execute complex, auto-documenting workflows linked to multiple codes on local and remote computers.
1616
* **High-throughput:** AiiDA's event-based workflow engine supports tens of thousands of processes per hour with full check-pointing.
1717
* **Data provenance:** AiiDA automatically tracks and records inputs, outputs and metadata of all calculations and workflows in extensive provenance graphs that preserve the full lineage of all data.
1818
* **Advanced queries:** AiiDA's query language enables fast graph queries on millions of nodes.
1919
* **Plugin interface:** AiiDA can support via plugins any computational code and data analytics tool, data type, scheduler, connection mode, etc. (see `public plugin repository <https://aiidateam.github.io/aiida-registry/>`__).
20-
* **HPC interface:** AiiDA can seamlessly deal with heterogeneous and remote computing resources; it works with many schedulers out of the box (`SLURM <https://slurm.schedmd.com>`__, `PBS Pro <https://www.pbspro.org/>`__, `torque <http://www.adaptivecomputing.com/products/torque/>`__, `SGE <http://gridscheduler.sourceforge.net/>`__ or `LSF <https://www.ibm.com/docs/en/spectrum-lsf>`__).
20+
* **HPC interface:** AiiDA can seamlessly deal with heterogeneous and remote computing resources; it works with many schedulers out of the box (`SLURM <https://slurm.schedmd.com>`__, `PBS Pro <https://www.pbspro.org/>`__, `torque <https://docs.adaptivecomputing.com/torque/5-0-0/help.htm>`__, `SGE <http://gridscheduler.sourceforge.net/>`__ or `LSF <https://www.ibm.com/docs/en/spectrum-lsf>`__).
2121
* **Open science:** AiiDA allows to export both full databases and selected subsets, to be shared with collaborators or made available and browsable online on the `Archive <https://archive.materialscloud.org/>`__ and `Explore <https://www.materialscloud.org/explore>`__ sections of `Materials Cloud <https://www.materialscloud.org>`__.
2222
* **Open source:** AiiDA is released under the `MIT open-source license <https://github.com/aiidateam/aiida-core/blob/main/LICENSE.txt>`__.
2323

docs/source/tutorials/basic.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ def multiply(x, y):
172172
return x * y
173173
```
174174

175-
This converts the `multiply` function into an AiIDA *calculation function*, the most basic execution unit in AiiDA.
175+
This converts the `multiply` function into an AiiDA *calculation function*, the most basic execution unit in AiiDA.
176176
Next, load the `Int` node you have created in the previous section using the `load_node` function and the PK of the data node:
177177

178178
```{code-cell} ipython3
@@ -251,7 +251,7 @@ graph.graphviz
251251
```
252252

253253
:::{note}
254-
Remember that the PK of the `CalcJob` can be different for your database.
254+
Remember that the PK of the `calcfunction` can be different for your database.
255255
:::
256256

257257
(tutorial:basic:calcjob)=
@@ -500,7 +500,7 @@ class MultiplyAddWorkChain(WorkChain):
500500
```
501501

502502
:::{note}
503-
Besides WorkChain's, workflows can also be implemented as {ref}`work functions <topics:workflows:concepts:workfunctions>`.
503+
Besides WorkChains, workflows can also be implemented as {ref}`work functions <topics:workflows:concepts:workfunctions>`.
504504
These are ideal for workflows that are not very computationally intensive and can be easily implemented in a Python function.
505505
:::
506506

0 commit comments

Comments
 (0)