Skip to content
This repository was archived by the owner on Oct 24, 2024. It is now read-only.

Commit 721608c

Browse files
committed
update log bumping
1 parent fbf6b65 commit 721608c

File tree

3 files changed

+50
-41
lines changed

3 files changed

+50
-41
lines changed

.bumpversion.cfg

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,7 @@ replace = release = '{new_version}'
1515
[bumpversion:file:src/compas_fea/__init__.py]
1616
search = __version__ = '{current_version}'
1717
replace = __version__ = '{new_version}'
18+
19+
[bumpversion:file:CHANGELOG.md]
20+
search = Unreleased
21+
replace = [{new_version}] {now:%Y-%m-%d}

CHANGELOG.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99

1010
### Added
1111

12-
### Changed
13-
14-
### Removed
15-
16-
17-
## Unreleased
18-
19-
### Added
20-
21-
* Added support for `compas` v1.0
22-
* Include changelog for releases
12+
* Added support for `compas` v1.0.
13+
* Include changelog for releases.
14+
* Added changelog to bump version.
2315

2416
### Changed
2517

docs/gettingstarted/installation.rst

Lines changed: 43 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,56 +2,69 @@
22
Installation
33
********************************************************************************
44

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::
136

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.
1614

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.
1818

1919

20-
.. note::
20+
Requirements
21+
============
2122

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.
2327

28+
To install COMPAS, see the `Getting Started <https://compas-dev.github.io/main/gettingstarted.html>`_
29+
instructions in the COMPAS docs.
2430

25-
From Local Source
26-
=================
2731

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+
=========================
3034

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.
3236

3337
.. code-block:: bash
3438
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
3742
3843
39-
From GitHub
40-
===========
44+
Working in Rhino
45+
================
4146

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.
4348

4449
.. code-block:: bash
4550
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
4757

4858

49-
Verify
50-
======
59+
Working in Blender
60+
==================
5161

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
5365
54-
.. code-block:: Python
66+
conda activate fea
67+
python -m compas_blender.install -v 2.93
5568
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

Comments
 (0)