Skip to content

Commit 44090af

Browse files
committed
update installation headers
1 parent 56bb35e commit 44090af

File tree

1 file changed

+21
-15
lines changed

1 file changed

+21
-15
lines changed

docs/source/installation.rst

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Installation Guide For: Users
2020
The instructions below assume you have already installed `python <https://www.python.org/downloads/>`_, with the release version meeting the constraints set in the `Installation Requirements`_ section, and do not have a Python environment already active.
2121

2222
1. Verify your python version
23-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
23+
==============================
2424

2525
Ensure your python version meets the requirements from the `Installation Requirements`_ section using the following command:
2626

@@ -34,12 +34,12 @@ If your current Python version is not supported by Schematic, you can switch to
3434
You can double-check the current supported python version by opening up the `pyproject.toml <https://github.com/Sage-Bionetworks/schematic/blob/main/pyproject.toml#L39>`_ file in this repository and finding the supported versions of python in the script.
3535

3636
2. Set up your virtual environment
37-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
37+
===================================
3838

3939
Once you are working with a python version supported by `schematic`, you will need to activate a virtual environment within which you can install the package. Below we will show how to create your virtual environment either with ``venv`` or with ``conda``.
4040

4141
2a. Set up your virtual environment with ``venv``
42-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
42+
--------------------------------------------------
4343

4444
Python 3 has built-in support for virtual environments with the ``venv`` module, so you no longer need to install ``virtualenv``:
4545

@@ -49,7 +49,7 @@ Python 3 has built-in support for virtual environments with the ``venv`` module,
4949
source .venv/bin/activate
5050
5151
2b. Set up your virtual environment with ``conda``
52-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
52+
----------------------------------------------------
5353

5454
``conda`` is a powerful package and environment management tool that allows users to create isolated environments used particularly in data science and machine learning workflows. If you would like to manage your environments with ``conda``, continue reading:
5555

@@ -74,7 +74,7 @@ Python 3 has built-in support for virtual environments with the ``venv`` module,
7474
conda activate schematicpy
7575
7676
3. Install ``schematic`` dependencies
77-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
77+
======================================
7878

7979
Install the package using `pip <https://pip.pypa.io/en/stable/getting-started/>`_:
8080

@@ -89,7 +89,7 @@ If you run into ``ERROR: Failed building wheel for numpy``, the error might be a
8989
pip3 install --upgrade pip
9090
9191
4. Get your data model as a ``JSON-LD`` schema file
92-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92+
=====================================================
9393

9494
Now you need a schema file, e.g. ``model.jsonld``, to have a data model that schematic can work with. While you can download a super basic `example data model <https://raw.githubusercontent.com/Sage-Bionetworks/schematic/refs/heads/develop/tests/data/example.model.jsonld>`_, you'll probably be working with a DCC-specific data model. For non-Sage employees/contributors using the CLI, you might care only about the minimum needed artifact, which is the ``.jsonld``; locate and download only that from the right repo.
9595

@@ -99,7 +99,7 @@ Here are some example repos with schema files:
9999
- https://github.com/nf-osi/nf-metadata-dictionary/
100100

101101
5. Obtain Google credential files
102-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
102+
==================================
103103

104104
Any function that interacts with a Google sheet (such as ``schematic manifest get``) requires Google Cloud credentials.
105105

@@ -122,7 +122,7 @@ Once you have obtained credentials, be sure that the json file generated is name
122122
.. _Set up configuration files:
123123

124124
6. Set up configuration files
125-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
125+
==============================
126126

127127
The following section will walk through setting up your configuration files with your credentials to allow for communication between ``schematic`` and the Synapse API.
128128

@@ -131,6 +131,8 @@ There are two main configuration files that need to be created and modified:
131131
- ``.synapseConfig``
132132
- ``config.yml``
133133

134+
.. _create_synapse_config:
135+
134136
**Create and modify the .synapseConfig**
135137

136138
The ``.synapseConfig`` file is what enables communication between ``schematic`` and the Synapse API using your credentials. You can automatically generate a ``.synapseConfig`` file by running the following in your command line and following the prompts.
@@ -169,17 +171,19 @@ Once you have finished setting up your development environment using the instruc
169171

170172
Please note we have a `code of conduct <https://github.com/Sage-Bionetworks/schematic/blob/main/CODE_OF_CONDUCT.md>`_, please follow it in all your interactions with the project.
171173

174+
172175
1. Clone the ``schematic`` package repository
173-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
176+
=============================================
174177

175178
For development, you will be working with the latest version of ``schematic`` on the repository to ensure compatibility between its latest state and your changes. Ensure your current working directory is where you would like to store your local fork before running the following command:
176179

177180
.. code-block:: shell
178181
179182
git clone https://github.com/Sage-Bionetworks/schematic.git
180183
184+
181185
2. Install ``poetry``
182-
~~~~~~~~~~~~~~~~~~~~~
186+
=====================
183187

184188
Install ``poetry`` (version 1.3.0 or later) using either the `official installer <https://python-poetry.org/docs/#installing-with-the-official-installer>`_ or ``pip``. If you have an older installation of Poetry, we recommend uninstalling it first.
185189

@@ -193,8 +197,9 @@ Check to make sure your version of poetry is > v1.3.0
193197
194198
poetry --version
195199
200+
196201
3. Start the virtual environment
197-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
202+
=================================
198203

199204
Change directory (``cd``) into your cloned ``schematic`` repository, and initialize the virtual environment using the following command with ``poetry``:
200205

@@ -208,8 +213,9 @@ To make sure your poetry version and python version are consistent with the vers
208213
209214
poetry debug info
210215
216+
211217
4. Install ``schematic`` dependencies
212-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
218+
======================================
213219

214220
Before you begin, make sure you are in the latest ``develop`` branch of the repository.
215221

@@ -225,7 +231,7 @@ This command will install:
225231
- Documentation dependencies such as ``sphinx`` for building and maintaining documentation.
226232

227233
5. Set up configuration files
228-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
234+
=================================
229235

230236
The following section will walk through setting up your configuration files with your credentials to allow for communication between ``schematic`` and the Synapse API.
231237

@@ -281,7 +287,7 @@ Once you've copied the file, modify its contents according to your use case. For
281287
``config.yml`` is ignored by git.
282288

283289
6. Obtain Google credential files
284-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
290+
==================================
285291

286292
Any function that interacts with a Google Sheet (such as ``schematic manifest get``) requires Google Cloud credentials.
287293

@@ -307,6 +313,6 @@ Once you have obtained credentials, ensure that the JSON file generated is named
307313

308314

309315
7. Verify your setup
310-
~~~~~~~~~~~~~~~~~~~~
316+
=====================
311317

312318
After running the steps above, your setup is complete, and you can test it in a ``python`` instance or by running a command based on the examples

0 commit comments

Comments
 (0)