Skip to content

Commit bfde9a8

Browse files
authored
Merge pull request #83 from deepskies/typos_versions
Update version, fix depedencies
2 parents 35a14ee + b8179a9 commit bfde9a8

File tree

6 files changed

+475
-701
lines changed

6 files changed

+475
-701
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ pytest
2525

2626
## Quickstart
2727

28-
[View the template yaml here for a minimially working example with our supplied sample data to get started.](https://github.com/deepskies/DeepDiagnostics/blob/main/config.yml.template)
28+
[View the template yaml here for a minimally working example with our supplied sample data to get started.](https://github.com/deepskies/DeepDiagnostics/blob/main/config.yml.template)
2929

3030
### Pipeline
3131
`DeepDiagnostics` includes a CLI tool for analysis.
@@ -53,11 +53,11 @@ It is encouraged, but not required.
5353

5454

5555
``` py
56-
from DeepDiagnostics.utils.configuration import Config
57-
from DeepDiagnostics.model import SBIModel
58-
from DeepDiagnostics.data import H5Data
56+
from deepdiagnostics.utils.configuration import Config
57+
from deepdiagnostics.model import SBIModel
58+
from deepdiagnostics.data import H5Data
5959

60-
from DeepDiagnostics.plots import LocalTwoSampleTest, Ranks
60+
from deepdiagnostics.plots import LocalTwoSampleTest, Ranks
6161

6262
Config({configuration_path})
6363
model = SBIModel({model_path})
@@ -177,7 +177,7 @@ For this example, we will add a new metric, but an identicial workflow takes pla
177177

178178
1. Add the name and mapping to the submodule `__init__.py`.
179179

180-
##### `src/deepdiagonstics/metrics/__init__.py`
180+
##### `src/deepdiagnostics/metrics/__init__.py`
181181

182182
``` py
183183
...
@@ -193,7 +193,7 @@ Metrics = {
193193

194194
2. Add the name and defaults to the `Defaults.py`
195195

196-
##### `src/deepdiagonstics/utils/Defaults.py`
196+
##### `src/deepdiagnostics/utils/Defaults.py`
197197

198198
``` py
199199
Defaults = {
@@ -211,7 +211,7 @@ Defaults = {
211211
##### `tests/test_metrics.py`
212212

213213
``` py
214-
from deepdaigonstics.metrics import NewMetric
214+
from deepdiagnostics.metrics import NewMetric
215215

216216
...
217217

@@ -237,7 +237,7 @@ python3 -m pytest tests/test_metrics.py::test_newmetric
237237
##### `docs/source/metrics.rst`
238238

239239
``` rst
240-
from deepdaigonstics.metrics import NewMetric
240+
from deepdiagnostics.metrics import NewMetric
241241
242242
.. _metrics:
243243
@@ -248,7 +248,7 @@ Metrics
248248
:members:
249249
...
250250
251-
.. autoclass:: deepdiagonstics.metrics.newmetric.NewMetric
251+
.. autoclass:: deepdiagnostics.metrics.newmetric.NewMetric
252252
:members: calculate
253253
254254
.. bibliography::

0 commit comments

Comments
 (0)