diff --git a/docs/sphinx/user_guide/notebooks/installation.ipynb b/docs/sphinx/user_guide/notebooks/installation.ipynb index 5ff0e4bb..917caaab 100644 --- a/docs/sphinx/user_guide/notebooks/installation.ipynb +++ b/docs/sphinx/user_guide/notebooks/installation.ipynb @@ -84,34 +84,60 @@ "1. Install conda. We recommend installing [Mambaforge](https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html), which is a conda installation with\n", "`mamba` installed by default and set to use `conda-forge` as the default set of package repositories.\n", "\n", - "2. Clone the git repo:\n", - "\n", - " ```bash\n", - " git clone git@github.com:JamesYang007/adelie.git\n", - " ```\n", - "\n", + "2. Clone the git repo:" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "%%bash\n", + "git clone git@github.com:JamesYang007/adelie.git" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ "3. Set up `adelie` conda environment. The list of packages that will be installed in the environment\n", - "is in `environment.yml` and `pyproject.toml`.\n", - "\n", - " ```bash\n", - " mamba update -y conda mamba\n", - " mamba env create\n", - " conda activate adelie\n", - " poetry config virtualenvs.create false --local\n", - " poetry install --no-root\n", - " ```\n", - "\n", - "4. Install `adelie` in editable mode:\n", - "\n", - " ```bash\n", - " pip install -e .\n", - " ```" + "is in `environment.yml` and `pyproject.toml`. The following will create a conda environment called `adelie`" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "%%bash\n", + "conda create env -f environment.yml\n", + "conda activate adelie" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "4. Install `adelie` in editable mode:" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "%%bash\n", + "pip install -e ." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ + "\n", "## __Verify Installation__" ] }, @@ -124,17 +150,40 @@ }, { "cell_type": "code", - "execution_count": 1, + "execution_count": null, "metadata": {}, "outputs": [], "source": [ "import adelie as ad" ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## __Run Tests__\n", + "\n", + "To run the tests you'll need `pytest` and `cvxpy`" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "%%bash\n", + "pip install pytest cvxpy\n", + "pytest tests" + ] } ], "metadata": { + "jupytext": { + "formats": "ipynb,Rmd" + }, "kernelspec": { - "display_name": "adelie", + "display_name": "Python 3 (ipykernel)", "language": "python", "name": "python3" }, @@ -148,9 +197,9 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.10.6" + "version": "3.10.0" } }, "nbformat": 4, - "nbformat_minor": 2 + "nbformat_minor": 4 } diff --git a/environment.yml b/environment.yml index 454931e1..177f357f 100644 --- a/environment.yml +++ b/environment.yml @@ -10,3 +10,4 @@ dependencies: - ccache - pip: - poetry + - pybind11