mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-16 10:34:31 +00:00
Add pip/docker install instructions
This commit is contained in:
@@ -155,7 +155,7 @@ changes, you'll need to fix your setup manually. But this is relatively rare.
|
||||
Packaged installation
|
||||
---------------------
|
||||
|
||||
- **Arch Linux**: `Stable <https://aur.archlinux.org/packages/ifcopenshell-git/>`__.
|
||||
- **Arch Linux**: `Direct from Git <https://aur.archlinux.org/packages/ifcopenshell-git/>`__.
|
||||
- **Chocolatey on Windows**: `Unstable <https://community.chocolatey.org/packages/blenderbim-nightly/>`__.
|
||||
|
||||
Tips for package managers
|
||||
|
||||
@@ -125,15 +125,8 @@ elements starting at item number 30,000 and ending at item number 50,000. This
|
||||
allows you to arbitrarily break down large models into submodels. This can be
|
||||
combined with other filters.
|
||||
|
||||
`Alpha versions of Blender <https://builder.blender.org/download/patch/>`__ may
|
||||
be used which will result in a faster load time (~10%).
|
||||
|
||||
.. seealso::
|
||||
|
||||
Blender is working on resolving some performance bottlenecks related to high
|
||||
object counts. See `D9892 <https://developer.blender.org/D9892>`__, `D15129
|
||||
<https://developer.blender.org/D15129>`__ (available in Blender 3.3 alpha),
|
||||
and `D14162 <https://developer.blender.org/D14162>`__
|
||||
`Beta versions of Blender 3.3 <https://builder.blender.org/download/patch/>`__
|
||||
may be used which will result in a faster load time (~50%).
|
||||
|
||||
Coordination only models
|
||||
------------------------
|
||||
|
||||
@@ -5,8 +5,9 @@ There are different methods of installation, depending on your situation.
|
||||
|
||||
1. **Pre-built packages** is recommended for users wanting to use the latest IfcOpenShell builds.
|
||||
2. **Conda** is recommended for developers using Anaconda.
|
||||
3. **Compiling from source** is recommended for developers actively working with the C++ core.
|
||||
4. **Packaged installation** is recommended for those who use a package manager.
|
||||
3. **Docker** is recommended for developers using Docker.
|
||||
4. **Compiling from source** is recommended for developers actively working with the C++ core.
|
||||
5. **Packaged installation** is recommended for those who use a package manager.
|
||||
|
||||
Pre-built packages
|
||||
------------------
|
||||
@@ -44,6 +45,17 @@ Conda
|
||||
|
||||
Installing IfcConvert from Conda will also install IfcOpenShell-Python.
|
||||
|
||||
Docker
|
||||
------
|
||||
|
||||
.. code-block::
|
||||
|
||||
$ docker run -it aecgeeks/ifcopenshell IfcConvert
|
||||
|
||||
.. note::
|
||||
|
||||
Installing IfcConvert from Docker will also install IfcOpenShell-Python.
|
||||
|
||||
Compiling from source
|
||||
---------------------
|
||||
|
||||
|
||||
@@ -4,10 +4,11 @@ Installation
|
||||
There are different methods of installation, depending on your situation.
|
||||
|
||||
1. **Pre-built packages** is recommended for users wanting to use the latest IfcOpenShell builds.
|
||||
2. **Pip** is recommended for managing a more stable IfcOpenShell version.
|
||||
2. **PyPI** is recommended for developers using Pip.
|
||||
3. **Conda** is recommended for developers using Anaconda.
|
||||
4. **Using the BlenderBIM Add-on** is recommended for non-developers wanting a graphical interface.
|
||||
5. **Compiling from source** is recommended for developers actively working with the C++ core.
|
||||
4. **Docker** is recommended for developers using Docker.
|
||||
5. **Using the BlenderBIM Add-on** is recommended for non-developers wanting a graphical interface.
|
||||
6. **Compiling from source** is recommended for developers actively working with the C++ core.
|
||||
|
||||
Pre-built packages
|
||||
------------------
|
||||
@@ -61,7 +62,7 @@ Pre-built packages
|
||||
code in Python:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
|
||||
import sys
|
||||
print(sys.path)
|
||||
|
||||
@@ -77,10 +78,12 @@ Pre-built packages
|
||||
print(ifcopenshell.version)
|
||||
model = ifcopenshell.file()
|
||||
|
||||
Pip
|
||||
---
|
||||
PyPI
|
||||
----
|
||||
|
||||
TODO
|
||||
.. code-block::
|
||||
|
||||
pip install ifcopenshell-python
|
||||
|
||||
Conda
|
||||
-----
|
||||
@@ -96,6 +99,17 @@ Conda
|
||||
|
||||
Installing IfcOpenShell from Conda will also install IfcConvert.
|
||||
|
||||
Docker
|
||||
------
|
||||
|
||||
.. code-block::
|
||||
|
||||
$ docker run -it aecgeeks/ifcopenshell python3 -c 'import ifcopenshell; print(ifcopenshell.version)'
|
||||
|
||||
.. note::
|
||||
|
||||
Installing IfcOpenShell from Docker will also install IfcConvert.
|
||||
|
||||
Using the BlenderBIM Add-on
|
||||
---------------------------
|
||||
|
||||
|
||||
Reference in New Issue
Block a user