Skip to content
Merged
Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
b0fc133
correct installation doc page
valeriupredoi Jul 17, 2025
7095b1b
Update doc/quickstart/installation.rst
valeriupredoi Aug 11, 2025
9234977
Improved intro, starting to scaffold usage and useful stuff
Aug 13, 2025
8da5631
Working with datasets
Aug 13, 2025
a2ed024
removing the original scaffolding
Aug 13, 2025
569eb3b
s3 access docs
Aug 13, 2025
1b58b2a
Emphasizing that there are differences from h5py
Aug 13, 2025
e89c8a5
add api reference
davidhassell Aug 13, 2025
effb4a9
Merge remote-tracking branch 'refs/remotes/origin/add_documentation' …
Aug 13, 2025
fbf5e16
Adding the h5d and additional API information
Aug 13, 2025
c8e39ac
Improving docstrings in h5d.py
Aug 13, 2025
0139693
Some material for the optimising section. Absolutely needs checking (…
Aug 13, 2025
425732e
Would have been smart to have run sphinx first
Aug 13, 2025
ea20d70
add no0index to api members
valeriupredoi Aug 13, 2025
f06dbac
Adding details on S3 config to the optimising section
Aug 14, 2025
933bffc
Merge remote-tracking branch 'refs/remotes/origin/add_documentation' …
Aug 14, 2025
72b0d68
Update doc/introduction.rst
bnlawrence Aug 15, 2025
658aa1e
Update doc/introduction.rst
bnlawrence Aug 15, 2025
a10833e
Update doc/optimising.rst
bnlawrence Aug 15, 2025
24f0eaa
Update doc/optimising.rst
bnlawrence Aug 15, 2025
db09a82
Update doc/optimising.rst
bnlawrence Aug 15, 2025
bfb4b8a
Update doc/optimising.rst
bnlawrence Aug 15, 2025
bec1fbd
Update doc/quickstart/usage.rst
bnlawrence Aug 15, 2025
e8a6c2d
Update doc/quickstart/usage.rst
bnlawrence Aug 15, 2025
45149cd
Update doc/quickstart/usage.rst
bnlawrence Aug 15, 2025
28c3a0c
Update doc/quickstart/usage.rst
bnlawrence Aug 15, 2025
1c1cdbc
Modified the DatasetID class docstring to better reflect what it is r…
Aug 15, 2025
bd9622a
:noindex:
davidhassell Aug 15, 2025
dd435af
add correct s3 example
valeriupredoi Aug 15, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 25 additions & 6 deletions doc/quickstart/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,27 @@
Installation
************

Conda-mamba environment
-----------------------
Installation from conda-forge
-----------------------------

``pyfive`` is on conda forge and can be installed with either ``conda`` or ``mamba`` (``mamba`` is now the
defaut solver for ``conda`` so might as well just use ``conda``):

.. code-block:: bash

conda install -c conda-forge pyfive

Installation from PyPI
----------------------

``pyfive`` can be installed from PyPI:

.. code-block:: bash

pip install pyfive

Install from source: conda-mamba environment
--------------------------------------------

Use a Miniconda/Miniforge3 installer to create an environment using
our conda ``environment.yml`` file; download the latest Miniconda3 for Linux installer from
Expand All @@ -16,16 +35,16 @@ install it, then create and activate the Pyfive environment:

wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
bash Miniconda3-latest-Linux-x86_64.sh
(base) conda env create -n activestorage -f environment.yml
(base) conda activate activestorage
(base) conda env create -n pyfive -f environment.yml
(base) conda activate pyfive

.. note::

Our dependencies are all from ``conda-forge`` so there is no issue related
to the buggy (and paid-for) Anaconda main/defaults channel!
Comment thread
valeriupredoi marked this conversation as resolved.
Outdated

Installing Pyfive
--------------------------
Installing Pyfive from source
-----------------------------

The installation then can proceed: installing with ``pip`` and installing ``all`` (ie
installing the development and test install):
Expand Down
Loading