From 50232e1d49eb13d0ac2466876b8aead3973a11e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreas=20Kl=C3=B6ckner?= Date: Wed, 3 Jun 2020 02:30:21 +0200 Subject: [PATCH] Make install instructions less useless --- doc/misc.rst | 44 ++++++++++++++++++++++++++++++-------------- 1 file changed, 30 insertions(+), 14 deletions(-) diff --git a/doc/misc.rst b/doc/misc.rst index 488262ac..b3fa9ffa 100644 --- a/doc/misc.rst +++ b/doc/misc.rst @@ -3,28 +3,44 @@ Installation ============ -This command should install :mod:`meshmode`:: +This set of instructions is intended for 64-bit Linux and MacOS computers. - pip install meshmode +#. Make sure your system has the basics to build software. -(Note the extra "."!) + On Debian derivatives (Ubuntu and many more), + installing ``build-essential`` should do the trick. -You may need to run this with :command:`sudo`. -If you don't already have `pip `_, -run this beforehand:: + Everywhere else, just making sure you have the ``g++`` package should be + enough. - curl -O https://raw.github.com/pypa/pip/master/contrib/get-pip.py - python get-pip.py +#. Installing `miniforge for Python 3 on your respective system `_. -For a more manual installation, `download the source -`_, unpack it, and say:: +#. ``export CONDA=/WHERE/YOU/INSTALLED/miniforge3`` - python setup.py install + If you accepted the default location, this should work: -You may also clone its git repository:: + ``export CONDA=$HOME/miniforge3`` - git clone --recursive git://github.com/inducer/meshmode - git clone --recursive http://git.tiker.net/trees/meshmode.git +#. ``$CONDA/bin/conda create -n dgfem`` + +#. ``source $CONDA/bin/activate dgfem`` + +#. ``conda config --add channels conda-forge`` + +#. ``conda install git pip pocl islpy pyopencl`` + +#. Type the following command:: + + hash -r; for i in pymbolic cgen genpy modepy pyvisfile loopy meshmode; do python -m pip install git+https://github.com/inducer/$i.git; done + +Next time you want to use :mod:`meshmode`, just run the following command:: + + source /WHERE/YOU/INSTALLED/miniforge3/bin/activate dgfem + +You may also like to add this to a startup file (like :file:`$HOME/.bashrc`) or create an alias for it. + +After this, you should be able to run the `tests `_ +or `examples `_. User-visible Changes ==================== -- GitLab