From 752d79369d4045e7a0f35e37f3e9a017b380bbfa Mon Sep 17 00:00:00 2001 From: "Gerben J. de Boer" Date: Mon, 3 Jul 2023 15:31:31 +0200 Subject: [PATCH 1/6] Update README.md with Terra at Aqua reference Update README.md with Terra at Aqua reference --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c713ba5b..e8ccc523 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ # OpenCLSim -**Open** source **C**omplex **L**ogistics **Sim**ulation - Rule driven scheduling of cyclic activities for in-depth comparison of alternative operating strategies. For background please read our [WODCON 2022 paper](https://www.dredging.org/resources/ceda-publications-online/conference-proceedings/abstract/1126), also available at [ResearchGate](https://www.researchgate.net/publication/360852095_OpenCLSim_Discrete_Event_Dredging_Fleet_Simulation_to_Optimise_Project_Costs). +**Open** source **C**omplex **L**ogistics **Sim**ulation - Rule driven scheduling of cyclic activities for in-depth comparison of alternative operating strategies. For background please read our [WODCON 2022 paper](https://www.dredging.org/resources/ceda-publications-online/conference-proceedings/abstract/1126), also available at [ResearchGate](https://www.researchgate.net/publication/360852095_OpenCLSim_Discrete_Event_Dredging_Fleet_Simulation_to_Optimise_Project_Costs). And our [Terra et Aqua 2023 paper](https://www.iadc-dredging.com/article/simulating-for-sustainability-alternative-operating-strategies-for-energy-efficiency/), available at [ResearchGate](https://www.researchgate.net/publication/371782674_Simulating_for_Sustainability_Alternative_Operating_Strategies_for_Energy_Efficiency) as well. Documentation is found [here](https://openclsim.readthedocs.io). From e2c47925ecf845614186b02bd30b6f535b97b733 Mon Sep 17 00:00:00 2001 From: Fedor Baart Date: Sun, 8 Oct 2023 14:37:56 +0200 Subject: [PATCH 2/6] this package has both setup.py and pyproject.toml, making sure packages are installed with both paths --- setup.cfg | 1 + 1 file changed, 1 insertion(+) diff --git a/setup.cfg b/setup.cfg index a5e6d60c..2584a5c4 100644 --- a/setup.cfg +++ b/setup.cfg @@ -28,6 +28,7 @@ package_dir = install_requires = importlib-metadata; python_version<"3.8" + setuptools_scm[toml]>=5 pandas>=0.24.0 numpy networkx From afb8e071e4e6fe095ceaba77c23bf16b0a8e50d8 Mon Sep 17 00:00:00 2001 From: Fedor Baart Date: Sun, 8 Oct 2023 14:45:22 +0200 Subject: [PATCH 3/6] make sure we use new setuptools in combination with scm --- setup.cfg | 1 + 1 file changed, 1 insertion(+) diff --git a/setup.cfg b/setup.cfg index 2584a5c4..debd1416 100644 --- a/setup.cfg +++ b/setup.cfg @@ -27,6 +27,7 @@ package_dir = =src install_requires = + setuptools>=61 importlib-metadata; python_version<"3.8" setuptools_scm[toml]>=5 pandas>=0.24.0 From 4cd515fd42b9b8d62a537cd223faa416661069d8 Mon Sep 17 00:00:00 2001 From: Fedor Baart Date: Sun, 8 Oct 2023 14:50:22 +0200 Subject: [PATCH 4/6] replace - with _ --- setup.cfg | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.cfg b/setup.cfg index debd1416..ca32dd60 100644 --- a/setup.cfg +++ b/setup.cfg @@ -10,7 +10,7 @@ author_email = "m.vankoningsveld@tudelft.nl", summary = The OpenCLSim package aims to facilitate rule based planning of cyclic activities and in depth comparison of different system concepts. keywords = OpenCLSim license = MIT -home-page = https://github.com/TUDelft-CITG/openclsim +home_page = https://github.com/TUDelft-CITG/openclsim description-file = README.md long_description_content_type = text/markdown description_content_type = text/markdown From 32da9a181cc145360fe3b1c45eddb3743bf1cc58 Mon Sep 17 00:00:00 2001 From: Fedor Baart Date: Sun, 8 Oct 2023 14:58:33 +0200 Subject: [PATCH 5/6] replace setup.py with sphinx_build --- Makefile | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index f60f79d6..39638029 100644 --- a/Makefile +++ b/Makefile @@ -16,7 +16,6 @@ build: check-local-env @docker build \ -t $(IMAGE_NAME):latest \ . - ## up : Run application in dev mode (using docker-compose) up: @docker-compose -f docker-compose.yml -f .devcontainer/docker-compose.yml up -d; @@ -41,10 +40,12 @@ test: test-up ## docs : Generate docs docs: test-up @docker exec $(CONTAINER_NAME_APP) bash -c "pip install -e .[docs]" - @docker exec $(CONTAINER_NAME_APP) bash -c "python setup.py docs" + # build from setup.py is no longer supported + # https://github.com/sphinx-doc/sphinx/pull/11363 + @docker exec $(CONTAINER_NAME_APP) bash -c "sphinx-build docs docs/_build" @docker cp $(CONTAINER_NAME_APP):/$(IMAGE_NAME)/docs/_build/html/ html_docs @docker-compose down - + ## log : Start a log tail on the last docker-compose command log: @docker-compose logs -f --tail=100 From 93accc80911a11be0515906b0f2c233f76f9bee4 Mon Sep 17 00:00:00 2001 From: Fedor Baart Date: Mon, 9 Oct 2023 09:43:24 +0200 Subject: [PATCH 6/6] add correct directory --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 39638029..665c4725 100644 --- a/Makefile +++ b/Makefile @@ -42,7 +42,7 @@ docs: test-up @docker exec $(CONTAINER_NAME_APP) bash -c "pip install -e .[docs]" # build from setup.py is no longer supported # https://github.com/sphinx-doc/sphinx/pull/11363 - @docker exec $(CONTAINER_NAME_APP) bash -c "sphinx-build docs docs/_build" + @docker exec $(CONTAINER_NAME_APP) bash -c "sphinx-build docs docs/_build/html" @docker cp $(CONTAINER_NAME_APP):/$(IMAGE_NAME)/docs/_build/html/ html_docs @docker-compose down