Skip to content

Commit

Permalink
Update redirected links found by linkcheck
Browse files Browse the repository at this point in the history
  • Loading branch information
douglatornell committed Jul 11, 2022
1 parent 69c2c4b commit 9e0c9af
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 12 deletions.
2 changes: 1 addition & 1 deletion analysis_repo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Populate Your Analysis Repository
This section assumes that you have installed `Miniconda`_ or the `Anaconda Python distribution`_ on your laptop.

.. _Miniconda: https://docs.conda.io/en/latest/miniconda.html
.. _Anaconda Python distribution: https://www.anaconda.com/products/individual
.. _Anaconda Python distribution: https://www.anaconda.com/products/distribution

It also assumes that you have set up your :ref:`GitConfiguration`.

Expand Down
2 changes: 1 addition & 1 deletion conda_pkg_env_mgr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ but we have found that using :program:`conda` and explicitly managing software e
is more robust over time than using Anaconda.

.. _Conda: https://docs.conda.io/en/latest/
.. _Anaconda data science toolkit: https://www.anaconda.com/products/individual
.. _Anaconda data science toolkit: https://www.anaconda.com/products/distribution


TODO: Write an intro to conda
Expand Down
2 changes: 1 addition & 1 deletion contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Assuming that you have the `Anaconda Python Distribution`_ or `Miniconda3`_ inst
you can create and activate an environment called :kbd:`moad-docs` that will have all of the Python packages necessary for building the documentation with the commands:

.. _Conda: https://conda.io/en/latest/
.. _Anaconda Python Distribution: https://www.anaconda.com/products/individual
.. _Anaconda Python Distribution: https://www.anaconda.com/products/distribution
.. _Miniconda3: https://docs.conda.io/en/latest/miniconda.html

.. code-block:: bash
Expand Down
9 changes: 5 additions & 4 deletions jupyter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Jupyter is included in the `Anaconda Python Distribution`_.
If are using `Miniconda`_ to create and manage your Python environments,
you can install Jupyter by adding the :kbd:`jupyterlab` package to your environment description YAML file.

.. _Anaconda Python Distribution: https://www.anaconda.com/products/individual
.. _Anaconda Python Distribution: https://www.anaconda.com/products/distribution
.. _Miniconda: https://docs.conda.io/en/latest/miniconda.html

In a terminal window,
Expand Down Expand Up @@ -356,7 +356,7 @@ Compute Canada `explicitly stipulates`_ that we should not use Anaconda or :prog
So,
this section describes how to use a Python venv to install and run :command:`jupyter lab`.

.. _explicitly stipulates: https://docs.computecanada.ca/wiki/Anaconda/en
.. _explicitly stipulates: https://docs.alliancecan.ca/wiki/Anaconda/en

Use the Compute Canada module system to load Python,
preferably the most recent available version.
Expand Down Expand Up @@ -399,15 +399,16 @@ so we do it:
(jupyter)$ python3 -m pip install --no-index --upgrade pip
.. _Compute Canada venv docs: https://docs.computecanada.ca/wiki/Python#Creating_and_using_a_virtual_environment
.. _Compute Canada venv docs: https://docs.alliancecan.ca/wiki/Python#Creating_and_using_a_virtual_environment

Install the :kbd:`jupyterlab` package and other packages that we routinely use for analysis into the venv:

.. code-block:: bash
(jupyter)$ python3 -m pip install jupyterlab xarray h5netcdf bottleneck matplotlib cmocean
This will cause the list of packages :kbd:`jupyterlab xarray h5netcdf bottleneck matplotlib cmocean` to be installed from the package collections maintained by Compute Canada,
This will cause the list of packages :kbd:`jupyterlab xarray h5netcdf bottleneck matplotlib cmocean`
to be installed from the package collections maintained by Compute Canada,
or from the `Python Package Index (PyPI)`_.
Ideally all of the packages will be installed from the Compute Canada package collections,
ensuring that they have been built for best compatibility and optimization for the cluster architecture.
Expand Down
8 changes: 4 additions & 4 deletions python_packaging/pkg_structure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ References
.. _Ionel Cristian Mărieș's Packaging a python library blog post: https://blog.ionelmc.ro/2014/05/25/python-packaging/
.. _Brian Skinn's My How and Why pyproject.toml & the 'src' Project Structure blog post: https://bskinn.github.io/My-How-Why-Pyproject-Src/
.. _Brett Canon's Clarifying PEP 518 (a.k.a. pyproject.toml) blog post: https://snarky.ca/clarifying-pep-518/
.. _the Flit packaging and publisher tool: https://flit.readthedocs.io/en/latest/index.html
.. _the Flit packaging and publisher tool: https://flit.pypa.io/en/latest/index.html


.. note::
Expand All @@ -55,7 +55,7 @@ References
or project-specific environments.

.. _conda environments: https://docs.conda.io/projects/conda/en/latest/
.. _Anaconda Python distribution: https://www.anaconda.com/products/individual
.. _Anaconda Python distribution: https://www.anaconda.com/products/distribution

#. On HPC clusters we use the system-provided Python 3 module and install our packages using the `"user scheme" for installation`_ in combination with `"Editable" Installs`_,
that is,
Expand Down Expand Up @@ -410,7 +410,7 @@ After a release has been made the value of :kbd:`n` is incremented by 1,
and :kbd:`.dev0` is appended to the version identifier to indicate changes that will be included in the next release.

.. _CalVer: https://calver.org/
.. _PEP-440: https://www.python.org/dev/peps/pep-0440
.. _PEP-440: https://peps.python.org/pep-0440/

The :py:obj:`__version__` value is included as the :kbd:`version` metadata value in the :ref:`PkgSetupCfgFile` by including the line:

Expand Down Expand Up @@ -659,7 +659,7 @@ as of :kbd:`pip-19.1` in the spring of 2019,
`"Editable" Installs`_ are not supported for packages that contain a :file:`pyproject.toml` file.
Discussion by the Python Packaging Authority of how to resolve this issue is ongoing.

.. _pyproject.toml file: https://www.python.org/dev/peps/pep-0518/
.. _pyproject.toml file: https://peps.python.org/pep-0518/

The :file:`src/` layout advocated by `Hynek Schlawack's Testing & Packaging blog post`_ and `Ionel Cristian Mărieș's Packaging a python library blog post`_ was rejected pending a strong recommendation in its favour by the Python Packaging Authority and support for it in packaging tools like `the Flit packaging and publisher tool`_.

Expand Down
2 changes: 1 addition & 1 deletion ssh_access.rst
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ It should produce output like:
Are you sure you want to continue connecting (yes/no/[fingerprint])?
Type :kbd:`yes` to proceed.
(You can confirm :kbd:`grahams`'s host key fingerprint at https://docs.computecanada.ca/wiki/SSH_security_improvements#SSH_host_key_fingerprints if you want to).
(You can confirm :kbd:`grahams`'s host key fingerprint at https://docs.alliancecan.ca/wiki/SSH_security_improvements#SSH_host_key_fingerprints if you want to).

The output from :command:`ssh-copy-id` should continue with:

Expand Down

0 comments on commit 9e0c9af

Please sign in to comment.