Skip to content

Commit

Permalink
Removes numpy from setup. Fix binder link. Adds minimal Dockerfile ex…
Browse files Browse the repository at this point in the history
…ample.
  • Loading branch information
ebezzam authored Jul 1, 2020
1 parent 0c2b234 commit 6ce330c
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 4 deletions.
10 changes: 10 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.git
.idea
.env
.github
venv*
*egg-info
.cache
docs/
logo/
build/
6 changes: 6 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ Bugfix

- Issue #162 (crash with max_order>31 on windows), seems fixed by the new C++ simulator
- Test for issue #162 added
- Fix Binder link

Added
~~~~~~~

- Minimal `Dockerfile` example.

`0.4.0`_ - 2020-06-03
---------------------
Expand Down
12 changes: 12 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# NB: You will have to increase the memory of your Docker containers to 4 GB.
# Less may also be sufficient, but this is necessary for building the C++ code
# for pyroomacoustics. How to increase memory: https://docs.docker.com/docker-for-mac/#resources
#
# Then you can build with: `docker build -t pyroom_container .`
# And enter container with: `docker run -it pyroom_container:latest /bin/bash`
FROM ubuntu:18.04
RUN dpkg --add-architecture i386
RUN apt-get update
RUN apt-get install -y python3-dev python3-pip
RUN pip3 install numpy pybind11
RUN pip3 install pyroomacoustics==0.4.0
18 changes: 16 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
:target: http://pyroomacoustics.readthedocs.io/en/pypi-release/
:alt: Documentation Status
.. image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/LCAV/pyroomacoustics/next_gen_simulator?filepath=notebooks%2Fpyroomacoustics_demo.ipynb
:target: https://mybinder.org/v2/gh/LCAV/pyroomacoustics/master?filepath=notebooks%2Fpyroomacoustics_demo.ipynb
:alt: Test on mybinder

Summary
Expand All @@ -27,7 +27,7 @@ can be divided into three main components:

Together, these components form a package with the potential to speed up the time to market
of new algorithms by significantly reducing the implementation overhead in the
performance evaluation step. Please refer to `this notebook <https://mybinder.org/v2/gh/LCAV/pyroomacoustics/next_gen_simulator?filepath=notebooks%2Fpyroomacoustics_demo.ipynb>`_
performance evaluation step. Please refer to `this notebook <https://mybinder.org/v2/gh/LCAV/pyroomacoustics/master?filepath=notebooks%2Fpyroomacoustics_demo.ipynb>`_
for a demonstration of the different components of this package.

Room Acoustics Simulation
Expand Down Expand Up @@ -130,6 +130,19 @@ scenarios::
# run the newly created script
python <chosen_script_name>.py


We have also provided a minimal `Dockerfile` example in order to install and
run the package within a Docker container. Note that you should `increase the memory <https://docs.docker.com/docker-for-mac/#resources>`_
of your containers to 4 GB. Less may also be sufficient, but this is necessary
for building the C++ code extension. You can build the container with::

docker build -t pyroom_container .

And enter the container with::

docker run -it pyroom_container:latest /bin/bash


Dependencies
------------

Expand All @@ -138,6 +151,7 @@ The minimal dependencies are::
numpy
scipy>=0.18.0
Cython
pybind11

where ``Cython`` is only needed to benefit from the compiled accelerated simulator.
The simulator itself has a pure Python counterpart, so that this requirement could
Expand Down
2 changes: 0 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@
from codecs import open
from os import path

import numpy

# import version from file
with open("pyroomacoustics/version.py") as f:
exec(f.read())
Expand Down

0 comments on commit 6ce330c

Please sign in to comment.