|
2 | 2 | Installation |
3 | 3 | ******************************************************************************** |
4 | 4 |
|
5 | | -.. _Anaconda: https://www.continuum.io/ |
6 | | -.. _EPD: https://www.enthought.com/products/epd/ |
7 | | - |
8 | | - |
9 | | -To use ``compas_fea`` you need to install COMPAS, |
10 | | -and have at least on of the supported analysis backends available on your system. |
11 | | -Currently, ``compas_fea`` supports Abaqus, ANSYS, and OpenSEES to various degrees. |
12 | | -See :ref:`fea` for more detailed information. |
| 5 | +.. note:: |
13 | 6 |
|
14 | | -By installing COMPAS all required Python packages for ``compas_fea`` will be installed as well. |
15 | | -To install COMPAS, see the `Getting Started <https://compas-dev.github.io/main/gettingstarted.html>`_ instructions in the COMPAS docs. |
| 7 | + Old versions of :mod:`compas_fea` were installed by adding the location of a |
| 8 | + local source folder directly to the ``PYTHONPATH``. |
| 9 | + If you still have such a legacy install on your system, we highly recommend |
| 10 | + that you remove all traces of it, which means to remove :mod:`compas`, |
| 11 | + :mod:`compas_fea`, or any other COMPAS packages from your ``PYTHONPATH``, |
| 12 | + because it will interfere with the proper functioning of more modern, flexible |
| 13 | + and robust installation procedures adopted by the COMPAS ecosystem. |
16 | 14 |
|
17 | | -``compas_fea`` itself can be installed using ``pip`` from a local source repo, or directly from GitHub. |
| 15 | + This also applies to old procedures for installing COMPAS packages for Rhino. |
| 16 | + If you still have COMPAS packages registered directly in the ``Modules Search Path`` in Rhino, |
| 17 | + please remove them. |
18 | 18 |
|
19 | 19 |
|
20 | | -.. note:: |
| 20 | +Requirements |
| 21 | +============ |
21 | 22 |
|
22 | | - Make sure to install ``compas_fea`` in the same environment as COMPAS! |
| 23 | +To use :mod:`compas_fea` you need to install COMPAS, |
| 24 | +and have at least on of the supported analysis backends available on your system. |
| 25 | +Currently, :mod:`compas_fea` supports Abaqus, ANSYS, and OpenSEES to various degrees. |
| 26 | +See :ref:`fea` for more detailed information. |
23 | 27 |
|
| 28 | +To install COMPAS, see the `Getting Started <https://compas-dev.github.io/main/gettingstarted.html>`_ |
| 29 | +instructions in the COMPAS docs. |
24 | 30 |
|
25 | | -From Local Source |
26 | | -================= |
27 | 31 |
|
28 | | -To install from a local source repo, clone the repo onto your computer using your Favourite Git client, |
29 | | -or using the command line. |
| 32 | +Install :mod:`compas_fea` |
| 33 | +========================= |
30 | 34 |
|
31 | | -Then navigate to the root of the ``compas_fea`` repo and install using pip: |
| 35 | +As with all other COMPAS packages, we recommend to install :mod:`compas_fea` in a ``conda`` environment. |
32 | 36 |
|
33 | 37 | .. code-block:: bash |
34 | 38 |
|
35 | | - cd compas_fea |
36 | | - pip install -e . |
| 39 | + conda create -n fea -c conda-forge python=3.9 compas --yes |
| 40 | + conda activate fea |
| 41 | + pip install compas_fea |
37 | 42 |
|
38 | 43 |
|
39 | | -From GitHub |
40 | | -=========== |
| 44 | +Working in Rhino |
| 45 | +================ |
41 | 46 |
|
42 | | -To install directly from the GitHub repo, just do |
| 47 | +If you wish to use :mod:`compas_fea` in Rhino, you have to add it to the installed Rhino COMPAS packages. |
43 | 48 |
|
44 | 49 | .. code-block:: bash |
45 | 50 |
|
46 | | - $ pip install git+https://github.com/compas-dev/compas_fea.git#egg=compas_fea |
| 51 | + conda activate fea |
| 52 | + python -m compas_rhino.install -v 7.0 |
| 53 | + python -m compas_rhino.install -v 7.0 -p compas_fea |
| 54 | +
|
| 55 | +For more information about using COMPAS in Rhino, see the COMPAS docs: |
| 56 | +https://compas.dev/compas/dev/gettingstarted/rhino.html |
47 | 57 |
|
48 | 58 |
|
49 | | -Verify |
50 | | -====== |
| 59 | +Working in Blender |
| 60 | +================== |
51 | 61 |
|
52 | | -To check the installation, open an interactive Python prompt and import the package. |
| 62 | +To use :mod:`compas_fea` in Blender, you simply have to register the environment with Blender. |
| 63 | + |
| 64 | +.. code-block:: bash |
53 | 65 |
|
54 | | -.. code-block:: Python |
| 66 | + conda activate fea |
| 67 | + python -m compas_blender.install -v 2.93 |
55 | 68 |
|
56 | | - >>> import compas |
57 | | - >>> import compas_fea |
| 69 | +For more information about using COMPAS in Blender, see the COMPAS docs: |
| 70 | +https://compas.dev/compas/dev/gettingstarted/blender.html |
0 commit comments