diff --git a/README.rst b/README.rst index 3772b8a..c5cacff 100644 --- a/README.rst +++ b/README.rst @@ -69,12 +69,19 @@ Installation ------------ *fairly* requires Python 3.8 or later, and `ruamel.yaml` version *0.17.26* or later. It can be installed directly -using pip. +from **PYPI** or **Conda-Forge**. .. code:: shell + # Using pip pip install fairly +.. code:: shell + + # using anaconda or miniconda + conda install conda-forge::fairly + + Installing from source ~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/api/fairly.client.rst b/docs/api/fairly.client.rst index 9624d23..5ed6583 100644 --- a/docs/api/fairly.client.rst +++ b/docs/api/fairly.client.rst @@ -21,7 +21,7 @@ fairly.client.figshare module :show-inheritance: fairly.client.invenio module ---------------------------- +---------------------------- .. automodule:: fairly.client.invenio :members: @@ -35,3 +35,4 @@ Module contents :members: :undoc-members: :show-inheritance: + :noindex: diff --git a/docs/api/fairly.dataset.rst b/docs/api/fairly.dataset.rst index 64ef4c7..8077221 100644 --- a/docs/api/fairly.dataset.rst +++ b/docs/api/fairly.dataset.rst @@ -27,3 +27,4 @@ Module contents :members: :undoc-members: :show-inheritance: + :noindex: diff --git a/docs/installation.rst b/docs/installation.rst index adec5a1..4d02f86 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -21,7 +21,7 @@ The *Fairly Toolset* provides functionality for the core tasks of preparing, upl Installing the Toolset ------------------------ -You can install the full toolset by installing the JupyterLab extension from PyPI. The fairly package and CLI will be installed automatically. +You can install the *full toolset* by installing the JupyterLab extension from PyPI. The fairly package and CLI will be installed automatically. Linux / MacOS ''''''''''''''''''' @@ -56,12 +56,18 @@ If all you need is the *fairly* Python package and the CLI, you can install them Linux / MacOS ''''''''''''''''''' -On the terminal type: +On the terminal type, for PyPI: .. code-block:: shell pip install fairly +Or if using Anaconda or Miniconda: + +.. code-block:: shell + + conda install conda-forge::fairly + Installing from Source ''''''''''''''''''''''''' diff --git a/docs/osf2023.rst b/docs/osf2023.rst deleted file mode 100644 index 4c4e5cb..0000000 --- a/docs/osf2023.rst +++ /dev/null @@ -1,51 +0,0 @@ -Open Science Festival -====================== - -.. image:: img/osf-banner2023.png - :alt: Open Science Festival 2023 - -This page contains information relevant to the **workshop part of the Open Science Festival 2023, Rotterdam.** - -.. important:: - **If you have received an invitation to join our Virtual Lab.** Follow the steps below to configure access to a remote desktop where you can run *Fairly* and its JupyterLab extension during the workshop. This is a convenient way to follow the workshop without installing the toolset on your computer. - - Alternatively, you can install the toolset on your computer. See the instructions in :ref:`installation`. - -You will receive two emails when you have been added to the Azure Virtual Lab. The first email will contain an invitation to get access to an account in our organisation and a *username*; the second email will contain a *password*. Follow the steps below to configure access to our organisation and the Virtual Lab. - -.. warning:: - The invitations will expire after a few days. You will need to contact us to get a new invitation. - Please notice that the use of Virtual Labs is still in an **experimental phase** in our organisation, and the invitations will be rolled out gradually up until the date of the workshop. If you have questions or encounter any problems, please contact us via `this email `_. - -1. Activate Organization Account --------------------------------- - -1. Accept the invitation by clicking the link in the email. You will be redirected to a Microsoft log-in page where you can activate your account -2. Using the *username* and *pasword* you have received by email activate you account. You must change your password and complete the two-factor authentication using the Microsoft Authenticator app on your phone. **Please make sure to write down your new password**. You will need it to access the Virtual Lab. -3. Once you complete the account activation, log in to the Virtual Lab website https://labs.azure.com/ using your new account. - - .. note:: - - If you use other Microsoft accounts, you may need to log out first and then log in again using your new account. Ensure you are logged in to the correct account by checking the account name in the top right corner of the Azure Lab Portal. The account name you will receive from us contains the word **tudefltcloud4researchacc**. - -4. You should see the **OpenScience Festival** virtual machine. **Showing the virtual machine in your account may take some time**. Please check after a while if you do not see it immediately. - - .. image:: img/labs-home.png - :alt: Azure Portal - - - -2. Access Remote Desktop -------------------------- - -On the day of the workshop, you can access the virtual machine using a remote desktop. Follow the steps below to access the remote desktop. - -1. Start the virtual machine by switching the toggle button to the left **(1)**. The button will turn blue when the virtual machine is running. - - .. image:: img/labs-start.png - :alt: Azure Port - -2. Click on the **Connect** button **(2)**. A file with the extension **OpenScienceFestival.rdp** will be downloaded to your computer. - -3. On your computer, double-click on the downloaded file. You will be asked to connect to your virtual machine using a username and password. **The username and password for this step will be provided also by email.** - diff --git a/docs/package/installation.rst b/docs/package/installation.rst deleted file mode 100644 index 988c02f..0000000 --- a/docs/package/installation.rst +++ /dev/null @@ -1,46 +0,0 @@ -.. _installation: -Installation -######################## - -*fairly* is a Python package that provides functionality for the core tasks of preparing, uploading and downloading datasets from research data repositories. The package currently provides integration with `Invenio `_ and Figshare repositories. - -Installing using pip -======================== -The easier way to install *fairly* is using `pip`, it requires Python 3.8 or later. - -On the terminal type: - -.. code-block:: shell - - pip install fairly - - -Installing from source -========================== - -Installing *fairly* from source requires `setuptools` version 49.0 or later and `pip`. - -1. Clone or download the `source code `_: - -.. code-block:: shell - - git clone https://github.com/ITC-CRIB/fairly.git - - -2. Unzip if necessary, and move to the root directory: - -.. code-block:: shell - - cd fairly/ - - -3. Compile and install by doing: - -.. code-block:: shell - - pip install . - -.. note:: - Currently, the package only supports repositories based on `Zenodo `_ and `Figshare `_. For more details on how to use *fairy* and some examples, see the **Quick Start** section. - -