|
25 | 25 | "* __States__: Internal parameters (typically hidden states) used to represent the state of the system- can be the same as inputs/outputs but do not have to be.\n", |
26 | 26 | "* __Performance Metrics__: Performance characteristics of a system that are a function of system state, but are not directly measured. For example, a performance metric for a electric motor might be the maximum achievable torque \n", |
27 | 27 | "\n", |
28 | | - "The `prog_models` package has the following structure\n", |
29 | | - "* `prog_models.data_models` - package containing algorithms for data-driven models, and parent class `prog_models.data_models.DataModel`\n", |
30 | | - "* `prog_models.datasets` - package containing tools for downloading a few relevant datasets\n", |
31 | | - "* `prog_models.loading` - package containing tools for representing different loading profiles\n", |
32 | | - "* `prog_models.models.*` - implemented models (e.g., pump, valve, battery)\n", |
33 | | - "* `prog_models.utils.*` - various utility functions and classes\n", |
34 | | - "* `prog_models.CompositeModel` - model of a system-of-systems, combining multiple interrelated models into a single model\n", |
35 | | - "* `prog_model.EnsembleModel` - model combining multiple models of the same system into a single model\n", |
36 | | - "* `prog_models.LinearModel` - parent class for simple linear models\n", |
37 | | - "* `prog_models.PrognosticsModel` - parent class for all prognostics models - defines interfaces that a model must implement, and tools for simulating said model\n", |
| 28 | + "The `progpy` package has the following structure\n", |
| 29 | + "* `progpy.data_models` - package containing algorithms for data-driven models, and parent class `prog_models.data_models.DataModel`\n", |
| 30 | + "* `progpy.datasets` - package containing tools for downloading a few relevant datasets\n", |
| 31 | + "* `progpy.loading` - package containing tools for representing different loading profiles\n", |
| 32 | + "* `progpy.models.*` - implemented models (e.g., pump, valve, battery)\n", |
| 33 | + "* `progpy.utils.*` - various utility functions and classes\n", |
| 34 | + "* `progpy.CompositeModel` - model of a system-of-systems, combining multiple interrelated models into a single model\n", |
| 35 | + "* `progpy.EnsembleModel` - model combining multiple models of the same system into a single model\n", |
| 36 | + "* `progpy.LinearModel` - parent class for simple linear models\n", |
| 37 | + "* `progpy.PrognosticsModel` - parent class for all prognostics models - defines interfaces that a model must implement, and tools for simulating said model\n", |
38 | 38 | "\n", |
39 | | - "In addition to the `prog_models` package, the GitHub repository includes many examples illustrating how to use the package (see `examples/`), a template for implementing a new model (`prog_model_template`), and this tutorial (`tutorial.ipynb`). Documentation for prog_models and the full ProgPy can be found at <https://nasa.github.io/progpy>,\n", |
| 39 | + "In addition to the `proypy` package, the GitHub repository includes many examples illustrating how to use the package (see `examples/`), a template for implementing a new model (`prog_model_template`), and this tutorial (`tutorial.ipynb`). Documentation for ProgPy can be found at <https://nasa.github.io/progpy>,\n", |
40 | 40 | "\n", |
41 | | - "Before you start, make sure to install prog_models using the following command:\n", |
| 41 | + "Before you start, make sure to install progpy using the following command:\n", |
42 | 42 | "\n", |
43 | | - " pip install prog_models\n", |
| 43 | + " pip install progpy\n", |
44 | 44 | "\n", |
45 | 45 | "Now let's get started with some examples" |
46 | 46 | ] |
|
60 | 60 | "source": [ |
61 | 61 | "This first example is for using the included prognostics models. \n", |
62 | 62 | "\n", |
63 | | - "The `prog_models.models` package includes implemented models, including ones for pumps, valves, batteries, and more. See <https://nasa.github.io/progpy/api_ref/prog_models/IncludedModels.html> for a full description of the included models.\n", |
| 63 | + "The `progpy.models` package includes implemented models, including ones for pumps, valves, batteries, and more. See <https://nasa.github.io/progpy/api_ref/prog_models/IncludedModels.html> for a full description of the included models.\n", |
64 | 64 | "\n", |
65 | 65 | "First thing to do is to import the model you would like to use:" |
66 | 66 | ] |
67 | 67 | }, |
68 | 68 | { |
69 | 69 | "cell_type": "code", |
70 | | - "execution_count": 2, |
| 70 | + "execution_count": null, |
71 | 71 | "metadata": {}, |
72 | 72 | "outputs": [], |
73 | 73 | "source": [ |
74 | | - "from prog_models.models import BatteryCircuit" |
| 74 | + "from progpy.models import BatteryCircuit" |
75 | 75 | ] |
76 | 76 | }, |
77 | 77 | { |
|
86 | 86 | }, |
87 | 87 | { |
88 | 88 | "cell_type": "code", |
89 | | - "execution_count": 3, |
| 89 | + "execution_count": null, |
90 | 90 | "metadata": {}, |
91 | 91 | "outputs": [], |
92 | 92 | "source": [ |
|
177 | 177 | }, |
178 | 178 | { |
179 | 179 | "cell_type": "code", |
180 | | - "execution_count": 4, |
| 180 | + "execution_count": null, |
181 | 181 | "metadata": {}, |
182 | 182 | "outputs": [], |
183 | 183 | "source": [ |
|
263 | 263 | "metadata": {}, |
264 | 264 | "outputs": [], |
265 | 265 | "source": [ |
266 | | - "from prog_models.loading import Piecewise\n", |
| 266 | + "from progpy.loading import Piecewise\n", |
267 | 267 | "# Variable (piece-wise) future loading scheme \n", |
268 | 268 | "future_loading = Piecewise(batt.InputContainer, [600, 900, 1800, 3000, float('inf')], {'i': [2, 1, 4, 2, 3]})" |
269 | 269 | ] |
|
425 | 425 | "metadata": {}, |
426 | 426 | "outputs": [], |
427 | 427 | "source": [ |
428 | | - "from prog_models.models import ThrownObject\n", |
| 428 | + "from progpy.models import ThrownObject\n", |
429 | 429 | "\n", |
430 | 430 | "# Create an instance of the thrown object model with no process noise\n", |
431 | 431 | "m = ThrownObject(process_noise=False)\n", |
|
803 | 803 | "metadata": {}, |
804 | 804 | "outputs": [], |
805 | 805 | "source": [ |
806 | | - "from prog_models import PrognosticsModel\n", |
| 806 | + "from progpy import PrognosticsModel\n", |
807 | 807 | "\n", |
808 | 808 | "class ThrownObject(PrognosticsModel):\n", |
809 | 809 | " \"\"\"\n", |
|
1242 | 1242 | "* `examples.sim`, `examples.sim_battery_eol`, `examples.sim_pump`, `examples.sim_valve`, `examples.sim_powertrain`, `examples.sim_dcmotor_singlephase`: Examples using specific models from `prog_models.models`\n", |
1243 | 1243 | "* `examples.lstm_model`, `examples.full_lstm_model`, and `examples.custom_model`: Examples using data-driven models\n", |
1244 | 1244 | "\n", |
1245 | | - "Thank you for trying out this tutorial. Open an issue on github (https://github.com/nasa/prog_models/issues) or email Chris Teubert (christopher.a.teubert@nasa.gov) with any questions or issues." |
| 1245 | + "Thank you for trying out this tutorial. Open an issue on github (https://github.com/nasa/progpy/issues) or email Chris Teubert (christopher.a.teubert@nasa.gov) with any questions or issues." |
1246 | 1246 | ] |
1247 | 1247 | }, |
1248 | 1248 | { |
|
1270 | 1270 | "name": "python", |
1271 | 1271 | "nbconvert_exporter": "python", |
1272 | 1272 | "pygments_lexer": "ipython3", |
1273 | | - "version": "3.9.6" |
| 1273 | + "version": "3.11.0" |
1274 | 1274 | }, |
1275 | 1275 | "metadata": { |
1276 | 1276 | "interpreter": { |
|
0 commit comments