Merge remote-tracking branch 'origin/master' into fix/docs-timeseries…

…-to-df-warning-display-names
enlyze · Aug 26, 2024 · c4907a0 · c4907a0
2 parents d2ad07c + d1d393c
commit c4907a0
Show file tree

Hide file tree

Showing 31 changed files with 3,770 additions and 218 deletions.
diff --git a/.github/workflows/pull_request.yaml b/.github/workflows/pull_request.yaml
@@ -75,7 +75,7 @@ jobs:
 
  - name: Report test coverage
  if: ${{ matrix.coverage-report == true }}
- uses: rhs/pr-comment@1.0.4
+ uses: enlyze/pr-comment@v1.0.5
  env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  with:

diff --git a/.gitignore b/.gitignore
@@ -129,3 +129,6 @@ dmypy.json
 .pyre/
 
 .vscode/
+
+# Mac OS-specific storage files
+.DS_Store
diff --git a/README.rst b/README.rst
@@ -64,3 +64,9 @@ so:*
 .. code-block:: console
 
  $ export PYENCHANT_LIBRARY_PATH=/opt/homebrew/lib/libenchant-2.dylib
+
+
+Examples
+--------------------------------
+You can find examples of how to use the Python SDK here: `Notebooks <examples/notebooks>`_
+
diff --git a/docs/api_clients/production_runs/models.rst b/docs/api_clients/production_runs/models.rst
@@ -11,7 +11,7 @@ Models
  :exclude-members: model_config, model_fields
  :show-inheritance:
 
-.. autoclass:: Appliance()
+.. autoclass:: Machine()
  :members:
  :undoc-members:
  :exclude-members: model_config, model_fields

diff --git a/docs/api_clients/timeseries/models.rst b/docs/api_clients/timeseries/models.rst
@@ -11,7 +11,7 @@ Models
  :exclude-members: model_config, model_fields
  :show-inheritance:
 
-.. autoclass:: Appliance()
+.. autoclass:: Machine()
  :members:
  :undoc-members:
  :exclude-members: model_config, model_fields

diff --git a/docs/concepts.rst b/docs/concepts.rst
@@ -13,25 +13,25 @@ The concept of a *site* refers to a physical production site. Depending on its s
 your organization might have one or many of them. In the ENLYZE platform, each site has
 a name and an address, which makes it easy to identify for humans.
 
-.. _appliance:
+.. _machine:
 
-Appliance
+Machine
 ---------
 
-An *appliance* refers to a machine that your organization uses to produce goods. For
+A *machine* refers to a machine that your organization uses to produce goods. For
 example, a CNC-milling center, a blown film extrusion line or an injection molding
-machine all represent an appliance in the ENLYZE platform. Just as a physical machine is
-located at one production site, an appliance in the ENLYZE platform is associated with
+machine all represent a machine in the ENLYZE platform. Just as a physical machine is
+located at one production site, a machine in the ENLYZE platform is associated with
 exactly one :ref:`site <site>`.
 
 .. _variable:
 
 Variable
 --------
 
-A *variable* represents a process measure of one :ref:`appliance <appliance>` of which
-timeseries data is captured and stored in the ENLYZE platform. One appliance may have
-many variables, whereas one variable is only associated with one appliance.
+A *variable* represents a process measure of one :ref:`machine <machine>` of which
+timeseries data is captured and stored in the ENLYZE platform. One machine may have
+many variables, whereas one variable is only associated with one machine.
 
 .. _production_order:
 
@@ -45,7 +45,7 @@ MES and then synchronized into the ENLYZE platform. They are referenced by an id
 which oftentimes is a short combination of numbers and/or characters, like FA23000123.
 
 In the ENLYZE platform, a production order always encompasses the production of one
-single :ref:`product <product>` on one single :ref:`appliance <appliance>` within one
+single :ref:`product <product>` on one single :ref:`machine <machine>` within one
 or more :ref:`production runs <production_run>`.
 
 .. _production_run:
@@ -54,15 +54,15 @@ Production Run
 --------------
 
 A *production run* is a time frame within which a machine was producing a :ref:`product
-<product>` on an :ref:`appliance <appliance>` in order to complete a :ref:`production
+<product>` on a :ref:`machine <machine>` in order to complete a :ref:`production
 order <production_order>`. A production run always has a beginning and, if it's not
 still running, it also has an end.
 
-Usually, the operator of the appliance uses an interface to log the time when a certain
-production order has been worked on. For instance, this could be the appliance's HMI or
+Usually, the operator of the machine uses an interface to log the time when a certain
+production order has been worked on. For instance, this could be the machine's HMI or
 a tablet computer next to it. In German, this is often referred to as *Betriebsdatenerfassung* (BDE).
 It is common, that a production order is not completed in one go, but is interrupted
-several times for very different reasons, like a breakdown of the appliance or a
+several times for very different reasons, like a breakdown of the machine or a
 public holiday. These interruptions lead to the creation of multiple production runs
 for a single production order.
 
@@ -71,9 +71,9 @@ for a single production order.
 Product
 -------
 
-A *product* is the output of the production process which is executed by an
-:ref:`appliance <appliance>`, driven by a :ref:`production order <production_order>`. In
-the real world, an appliance might have some additional outputs, but only the main
+A *product* is the output of the production process which is executed by a
+:ref:`machine <machine>`, driven by a :ref:`production order <production_order>`. In
+the real world, a machine might have some additional outputs, but only the main
 output (the product) is modeled in the ENLYZE platform. Similarly to the production order,
 a product is referenced by an identifier originating from a customer's system, that gets
 synchronized into the ENLYZE platform.

diff --git a/docs/conf.py b/docs/conf.py
@@ -33,7 +33,7 @@
 ]
 
 templates_path = ["_templates"]
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".ipynb_checkpoints"]
 
 
 # -- Options for HTML output -------------------------------------------------
@@ -49,6 +49,9 @@
  ("py:class", r".*\.T"),
  ("py:.*", r"httpx\..*"),
 ]
+nitpick_ignore = [
+ ("py:class", "ComputedFieldInfo"),
+]
 
 autodoc_default_options = {"exclude-members": "__weakref__, __init__, __new__"}
 autodoc_member_order = "bysource"

diff --git a/docs/examples.rst b/docs/examples.rst
@@ -0,0 +1,7 @@
+Examples
+========
+In our examples section, you can find Jupyter Notebooks and other material to help you get started:
+
+`Notebooks <https://github.com/enlyze/enlyze-python/tree/master/examples/notebooks>`_:
+
+* `Introduction to the ENLYZE Python SDK <https://github.com/enlyze/enlyze-python/tree/master/examples/notebooks/introduction_enlyze_python_sdk.ipynb>`_
diff --git a/docs/index.rst b/docs/index.rst
@@ -14,6 +14,7 @@ User's Guide
 
  installation
  quickstart
+ examples
  concepts
  client
  models

diff --git a/docs/models.rst b/docs/models.rst
@@ -8,7 +8,7 @@ Data models
 .. autoclass:: Site()
  :members:
 
-.. autoclass:: Appliance()
+.. autoclass:: Machine()
  :members:
 
 .. autoclass:: Variable()

diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
@@ -21,3 +21,4 @@ url
 uuid
 virtualenv
 whitespace
+Jupyter