Add pyproject toml #52

rdmolony · 2020-12-17T16:38:23Z

I've added a pyproject.toml (via poetry) to manage dependencies and make this repo pip installable.

To manage project dependencies and to make it pip installable

Now that rc_buildingsimulator is a library can replace all relative imports with absolute imports and delete add to path sections of code

Undo changes to imports etc so that CI passes

* Add pyproject.toml To manage project dependencies and to make it pip installable * Rename imports in each module Now that rc_buildingsimulator is a library can replace all relative imports with absolute imports and delete add to path sections of code * Revert rc_buildingsimulator to rc_simulator Undo changes to imports etc so that CI passes

So that building_physics can be imported via rc_buildingsimulator - see notebooks/10-min-guide...

So installs a dev version of rc_buildingsimulator in CI and resolve CI bug - No module named 'rc_buildingsimulator'

poetry run flake8 resulted in ... ModuleNotFoundError: No module named 'importlib_metadata' for Python 3.6 and 3.7 ... python-poetry/poetry#1487

pjayathissa

Firstly, I love the PR, thank you so much. This is my first time using poetry, so pardon my ignorance. I have a set of questions before I can approve this.

Many users of this tool just clone the repo, globally pip install the dependencies and code away. They are often scientists and researchers with basic coding skills. With vagrant, I was able to offer both options. I could allow people to use vagrant to have a dependency manager, but if they didn't want that, they could just globally install the dependencies (most people have pandas, numpy etc already installed anyway). My concern with poetry is that it is a requirement and only runs through poetry. This has two issues
a. The user has to install poetry (following the instructions on the poetry website didn't work for me as (even with sudo) poetry can't manage my .bash_profile. I therefore had to homebrew it). This can be a bit overwhelming for the person who is just using a gui python installation like anaconda.
b. We become dependent on poetry

It would be great to somehow create this inbetween situation. Perhaps for now we could have two branches. The main, and dist? Once our user base is happy with the pypi and it's had some user testing, we can merge this dist branch to main

In order to push this to pypi, do I just run poetry build, poetry publish? Is there anything else I need to watch out for
Is there a reason that you changed the name from rc_simulator to rc_buildingsimulator. The latter seems quite verbose
I had issues running tests/testExamples.py. FileNotFoundError: [Errno 2] No such file or directory: 'examples/annualSimulation.py'

Looking forward to your reply. And sorry for the massive delay in reviewing. I work in healthcare at the moment, and the pandemic makes things quite busy.

pyproject.toml

pjayathissa · 2021-03-07T06:40:02Z

rc_buildingsimulator/building_physics.py

@@ -11,7 +11,7 @@

 ::

-    from buildingPhysics import Zone  #Importing Zone Class
+    from rc_buildingsimulator.building_physics import Zone  #Importing Zone Class


Out of curiosity. I there a reason for changing the headings from rc_simulator to rc_buildingsimulator?

pjayathissa · 2021-03-07T06:46:01Z

rc_buildingsimulator/building_physics.py

@@ -75,8 +75,8 @@

 """

-import supply_system
-import emission_system
+from rc_buildingsimulator import supply_system


I have a potential issue here. A lot of people that use this tool have basic python skills (they are often scientists and researchers, not developers). Package managing with poetry is nice, but this means that people will need to install poetry in order to run the script. Currently, I have used vagrant as a local dependency manager, and lazy python programmers can just skip the vagrant step by globally installing the necessary packages and getting on with it. I can't quite seem to do this with poetry and am hesitant as there is a risk that it will form a limitation to uptake. Do you have any ideas of how we can get around this?

As I understand, once we get this on pypi, people will just pip install it anyway

rdmolony · 2021-03-07T17:59:26Z

Hi @pjayathissa, thanks for the feedback and no worries on the delay!

As of v10.0 pip supports installing directly from a pyproject.toml file via pip install . so unless users are changing the source code they won't need it. If they are; the latest pip v21.0.1 requires a setup.py for pip install -e . editable installs so they'll need to use poetry install instead. I'm not familiar with vagrant as I tend to use docker or conda for environment management - conda install -c conda-forge poetry might resolve the homebrew issue as it comes included with Anaconda?
The dist and main branch seems like a handy way to just use poetry to publish to pypi if you don't want to pull it into the pyproject.toml into the main branch just yet & poetry build + poetry publish is all I do anyway!
Probably to bring it in sync with the name of the repo - makes no difference to me!
I'll look into it! Weird that it wasn't caught by CI

To prevent a plot window from appearing during unit testing

rdmolony · 2021-03-08T08:24:54Z

I just remembered that prior to poetry build + poetry publish you'll need to poetry version <CMD> as in the docs which updates the pyproject.toml version to the current version

pjayathissa · 2021-03-09T09:02:24Z

Thanks for the quick reply. You don't need to worry about running testExamples through CI. I just have that as a personal thing on my laptop to make sure that the examples are not failing.

1-2. I am leaning towards the idea of running this as a seperate dist branch, until the userbase has comfortably transitioned from using the git code-base to pip. There are a few PhD thesis that hang on this software so I don't want to make their life suddenly more complicated. Then once the dust has settled, we can merge to master. The changes to the base code is relatively minor so hopefully, this will work without too much drama.
3. Syncing with the repo name is a good idea. I'm just torn between the long name, and the reality that "RC Simulator" actually translates to "radio control simulator", or actual electrical RC circuits. I guess we keep it as it is.
4. Cool thanks, and no need to integrate it into CI. I had some issues with the matplotlib in the past

rdmolony added 2 commits December 17, 2020 15:57

Add pyproject.toml

adebb53

To manage project dependencies and to make it pip installable

Rename imports in each module

5cbb420

Now that rc_buildingsimulator is a library can replace all relative imports with absolute imports and delete add to path sections of code

rdmolony closed this Dec 17, 2020

rdmolony reopened this Dec 17, 2020

rdmolony added 7 commits December 17, 2020 16:49

Revert rc_buildingsimulator to rc_simulator

e0a9fdd

Undo changes to imports etc so that CI passes

Replace building_physics rel imports with absolute

498878e

So that building_physics can be imported via rc_buildingsimulator - see notebooks/10-min-guide...

Adapt github action for poetry

d891e12

So installs a dev version of rc_buildingsimulator in CI and resolve CI bug - No module named 'rc_buildingsimulator'

Add support for Python 3.6-3.9

294465b

Test CI for Python 3.8 only

fe576f8

poetry run flake8 resulted in ... ModuleNotFoundError: No module named 'importlib_metadata' for Python 3.6 and 3.7 ... python-poetry/poetry#1487

Merge branch 'codema-dev-master' into rdm-add-pyproject-toml

9dd4155

pjayathissa reviewed Mar 7, 2021

View reviewed changes

Replace author with [email protected]

89f4012

rdmolony added 2 commits March 7, 2021 18:19

Add testExamples to CI & fix paths for new struc

270e2e6

Mock matplotlib.pyplot.show

43eb459

To prevent a plot window from appearing during unit testing

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add pyproject toml #52

Add pyproject toml #52

rdmolony commented Dec 17, 2020 •

edited

Loading

pjayathissa left a comment •

edited

Loading

pjayathissa Mar 7, 2021

pjayathissa Mar 7, 2021

rdmolony commented Mar 7, 2021 •

edited

Loading

rdmolony commented Mar 8, 2021

pjayathissa commented Mar 9, 2021

Add pyproject toml #52

Are you sure you want to change the base?

Add pyproject toml #52

Conversation

rdmolony commented Dec 17, 2020 • edited Loading

pjayathissa left a comment • edited Loading

Choose a reason for hiding this comment

pjayathissa Mar 7, 2021

Choose a reason for hiding this comment

pjayathissa Mar 7, 2021

Choose a reason for hiding this comment

rdmolony commented Mar 7, 2021 • edited Loading

rdmolony commented Mar 8, 2021

pjayathissa commented Mar 9, 2021

rdmolony commented Dec 17, 2020 •

edited

Loading

pjayathissa left a comment •

edited

Loading

rdmolony commented Mar 7, 2021 •

edited

Loading