Merge pull request #27 from odtp-org/hypothesis-overlay

Hypothesis overlay
odtp-org · Apr 8, 2024 · 0e4c81a · 0e4c81a
2 parents 7f240a8 + e669288
commit 0e4c81a
Show file tree

Hide file tree

Showing 23 changed files with 9 additions and 42 deletions.
diff --git a/docs/components/components-definition.md b/docs/components/components-definition.md
@@ -47,5 +47,3 @@ Checkout the following topis:
 
 -  [How to run a component](components//how-to-run-a-component)
 -  [How to create a component](components/components-development)
-
-<script src="https://hypothes.is/embed.js" async></script>
diff --git a/docs/components/components-development.md b/docs/components/components-development.md
@@ -163,5 +163,3 @@ schema-output: PATH_TO_OUTPUT_SCHEMA
 devices:
   gpu: false
 ```
-
-<script src="https://hypothes.is/embed.js" async></script>
diff --git a/docs/components/how-to-run-a-component.md b/docs/components/how-to-run-a-component.md
@@ -48,5 +48,3 @@ odtp component delete-image --image_name image_test
 To start using component in Digital Twin's executions, first you need to register the component into odtp, and using it. 
 
 See the [tutorial](tutorials/components-and-versions.md) on how to do this.
-
-<script src="https://hypothes.is/embed.js" async></script>
diff --git a/docs/development/odtp-db-schema.md b/docs/development/odtp-db-schema.md
@@ -208,5 +208,3 @@ results = {
     "updated_at": datetime.utcnow(),
 }
 ```
-
-<script src="https://hypothes.is/embed.js" async></script>
diff --git a/docs/development/roadmap.md b/docs/development/roadmap.md
@@ -15,5 +15,3 @@
 - I/O operations optimization
 - Automatic executions planner
 - Enhancement of DB Schema
-
-<script src="https://hypothes.is/embed.js" async></script>
diff --git a/docs/index.md b/docs/index.md
@@ -48,5 +48,3 @@ Alternative commercial licensing options for the core platform and other compone
 
 ## Ethical Use and Legal Compliance Disclaimer
 Please note that this software should not be used to harm any individual or entity. Users and developers must adhere to ethical guidelines and use the software responsibly and legally. This disclaimer serves to remind all parties involved in the use or development of this software to engage in practices that are ethical, lawful, and in accordance with the intended purpose of the software.
-
-<script src="https://hypothes.is/embed.js" async></script>
diff --git a/docs/installation/docker-compose.md b/docs/installation/docker-compose.md
@@ -85,5 +85,3 @@ user ID: 65c3648260106cc50f650bc1
 ```
 
 Now that everything has been set up, you are ready to work. Head over to the [tutorials](tutorials/getting-started.md) 
-
-<script src="https://hypothes.is/embed.js" async></script>
diff --git a/docs/installation/odtp-installation.md b/docs/installation/odtp-installation.md
@@ -33,5 +33,3 @@ For test and development purposes we recommend to use the former, however this m
 
 1. First deploy all third-party dependencies following this [guide](odtp-third-party-services.md)
 2. Then install ODTP locally following these [instructions](odtp-local-installation.md)
-
-<script src="https://hypothes.is/embed.js" async></script>
diff --git a/docs/installation/odtp-local-installation.md b/docs/installation/odtp-local-installation.md
@@ -90,5 +90,3 @@ user ID: 65c3648260106cc50f650bc1
 ```
 
 Now that everything has been set up, you are ready to work. Head over to the [tutorials](tutorials/getting-started.md) 
-
-<script src="https://hypothes.is/embed.js" async></script>
diff --git a/docs/installation/odtp-third-party-services.md b/docs/installation/odtp-third-party-services.md
@@ -77,5 +77,3 @@ user ID: 65c3648260106cc50f650bc1
 ```
 
 Now that everything has been set up, you are ready to work. Head over to the [tutorials](tutorials/getting-started.md) 
-
-<script src="https://hypothes.is/embed.js" async></script>
diff --git a/docs/odtp-concepts.md b/docs/odtp-concepts.md
@@ -66,5 +66,3 @@ These modules are the different parts that we are developing for the ODTP. These
 
 ### Services
 One service or micro-service, in a micro-services architecture refers to one logical unit that performs one specific task in an independent manner. In ODTP we use different servers to support core modules, such as MongoDB for the database, Minion for the storage, or GraphDB for the knowledge graph storing. But also, from a technical standpoint every component is turned into a micro-service when running. I think this is the part that’s bringing more confusion. 
-
-<script src="https://hypothes.is/embed.js" async></script>
diff --git a/docs/odtp-digital-twin.md b/docs/odtp-digital-twin.md
@@ -35,5 +35,3 @@ One of the limitations in `ODTP v0.2.x` is that we only offer compatibility with
 ## `odtp-compose.yml`
 
 The goal of ODTP is to prioritize the flexibility and independence of the Digital Twins generated. That's why we are developing the exporting of each digital twin into an `odtp-compose.yml` file that can be executed directly by Docker. This file will offer the user the possibility to run one specific execution in an isolated and reproducible environment, ensuring consistency across different executions and facilitating collaboration and sharing among users. The `odtp-compose.yml` will include definitions for all the services involved in the execution, their configuration, inter-service dependencies, and any necessary environment variables or volume mounts.
-
-<script src="https://hypothes.is/embed.js" async></script>
diff --git a/docs/tutorials/components-and-versions.md b/docs/tutorials/components-and-versions.md
@@ -99,5 +99,3 @@ commit will be taken.
     component_id_: 65c3ab02b4afbca32db08738
     version_id_: 65e00bc02c01a56f2b8c95f9
     ```
-
-<script src="https://hypothes.is/embed.js" async></script>
diff --git a/docs/tutorials/executions.md b/docs/tutorials/executions.md
@@ -56,5 +56,3 @@ An execution consists of components and can have extra port mappings and paramet
     execution_id: 65c3ab980c57d37eb076b6ba
     step_ids 65c3ab980c57d37eb076b6bb, 65c3ab980c57d37eb076b6bc
     ```
-
-<script src="https://hypothes.is/embed.js" async></script>
diff --git a/docs/tutorials/getting-started.md b/docs/tutorials/getting-started.md
@@ -42,5 +42,3 @@ Checkout the following topis:
 -  [add components and versions](../components-and-versions)
 -  [add executions](../executions)
 -  [run executions](../run-executions)
-
-<script src="https://hypothes.is/embed.js" async></script>
diff --git a/docs/tutorials/run-executions.md b/docs/tutorials/run-executions.md
@@ -110,5 +110,3 @@ In this step the docker container for the components will run and produce the ac
     --execution-id 65c3ab980c57d37eb076b6ba \
     --projecoject-path 
     ```
-
-<script src="https://hypothes.is/embed.js" async></script>
diff --git a/docs/tutorials/users-and-digital-twins.md b/docs/tutorials/users-and-digital-twins.md
@@ -51,5 +51,3 @@ Once you have a user, you can set up a digital twin
     ```
     A digital twin has been added: 65a7c735732ae1d3fee2b946
     ``` 
-
-<script src="https://hypothes.is/embed.js" async></script>
diff --git a/docs/use-cases/mobility-causal-interventions.md b/docs/use-cases/mobility-causal-interventions.md
@@ -16,5 +16,3 @@ TBD
 ## Reference and contact
 
 TBD
-
-<script src="https://hypothes.is/embed.js" async></script>
diff --git a/docs/use-cases/mobility-eqasim-matsim.md b/docs/use-cases/mobility-eqasim-matsim.md
@@ -27,5 +27,3 @@ graph LR;
 ## Reference and contact
 
 TBD
-
-<script src="https://hypothes.is/embed.js" async></script>
diff --git a/docs/use-cases/use-cases.md b/docs/use-cases/use-cases.md
@@ -7,5 +7,3 @@ The development of ODTP is made in parallel to the adaptation of different use c
 
 - [Mobility: Eqasim and Matsim Simulation](mobility-eqasim-matsim.md)
 - [Mobility: Causal Inference](mobility-causal-interventions.md)
-
-<script src="https://hypothes.is/embed.js" async></script>
diff --git a/docs/zoo/zoo-definition.md b/docs/zoo/zoo-definition.md
@@ -37,5 +37,3 @@ In order to submit a component you need to make an entry in `components` directo
 ## How to deploy your own zoo
 
 TO BE DEVELOPED
-
-<script src="https://hypothes.is/embed.js" async></script>
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -5,6 +5,7 @@ repo_name: odtp-org/odtp
 theme:
   name: material
   logo: static/logo/logo.png
+  custom_dir: overrides  
   features:
     - navigation.tabs
     - navigation.sections

diff --git a/overrides/main.html b/overrides/main.html
@@ -0,0 +1,8 @@
+{% extends "base.html" %}
+
+{% block scripts %}
+  <!-- Add scripts that need to run before here -->
+  {{ super() }}
+  <!-- Add scripts that need to run afterwards here -->
+  <script src="https://hypothes.is/embed.js" async></script>
+{% endblock %}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -47,5 +47,3 @@ Checkout the following topis:

		- [How to run a component](components//how-to-run-a-component)
		- [How to create a component](components/components-development)

		<script src="https://hypothes.is/embed.js" async></script>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -48,5 +48,3 @@ odtp component delete-image --image_name image_test
		To start using component in Digital Twin's executions, first you need to register the component into odtp, and using it.

		See the [tutorial](tutorials/components-and-versions.md) on how to do this.

		<script src="https://hypothes.is/embed.js" async></script>
-Original file line number
+Diff line change
@@ Expand Up / @@ -208,5 +208,3 @@ results = { @@
         "updated_at": datetime.utcnow(),
     }
     ```
-    <script src="https://hypothes.is/embed.js" async></script>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -48,5 +48,3 @@ Alternative commercial licensing options for the core platform and other compone

		## Ethical Use and Legal Compliance Disclaimer
		Please note that this software should not be used to harm any individual or entity. Users and developers must adhere to ethical guidelines and use the software responsibly and legally. This disclaimer serves to remind all parties involved in the use or development of this software to engage in practices that are ethical, lawful, and in accordance with the intended purpose of the software.

		<script src="https://hypothes.is/embed.js" async></script>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -85,5 +85,3 @@ user ID: 65c3648260106cc50f650bc1
		```

		Now that everything has been set up, you are ready to work. Head over to the [tutorials](tutorials/getting-started.md)

		<script src="https://hypothes.is/embed.js" async></script>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -33,5 +33,3 @@ For test and development purposes we recommend to use the former, however this m

		1. First deploy all third-party dependencies following this [guide](odtp-third-party-services.md)
		2. Then install ODTP locally following these [instructions](odtp-local-installation.md)

		<script src="https://hypothes.is/embed.js" async></script>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -90,5 +90,3 @@ user ID: 65c3648260106cc50f650bc1
		```

		Now that everything has been set up, you are ready to work. Head over to the [tutorials](tutorials/getting-started.md)

		<script src="https://hypothes.is/embed.js" async></script>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -77,5 +77,3 @@ user ID: 65c3648260106cc50f650bc1
		```

		Now that everything has been set up, you are ready to work. Head over to the [tutorials](tutorials/getting-started.md)

		<script src="https://hypothes.is/embed.js" async></script>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -66,5 +66,3 @@ These modules are the different parts that we are developing for the ODTP. These

		### Services
		One service or micro-service, in a micro-services architecture refers to one logical unit that performs one specific task in an independent manner. In ODTP we use different servers to support core modules, such as MongoDB for the database, Minion for the storage, or GraphDB for the knowledge graph storing. But also, from a technical standpoint every component is turned into a micro-service when running. I think this is the part that’s bringing more confusion.

		<script src="https://hypothes.is/embed.js" async></script>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -35,5 +35,3 @@ One of the limitations in `ODTP v0.2.x` is that we only offer compatibility with
		## `odtp-compose.yml`

		The goal of ODTP is to prioritize the flexibility and independence of the Digital Twins generated. That's why we are developing the exporting of each digital twin into an `odtp-compose.yml` file that can be executed directly by Docker. This file will offer the user the possibility to run one specific execution in an isolated and reproducible environment, ensuring consistency across different executions and facilitating collaboration and sharing among users. The `odtp-compose.yml` will include definitions for all the services involved in the execution, their configuration, inter-service dependencies, and any necessary environment variables or volume mounts.

		<script src="https://hypothes.is/embed.js" async></script>