Skip to content

Commit

Permalink
doc-fix: import obs_sequence module so it does not clash with obs_seq…
Browse files Browse the repository at this point in the history
… instance

fixes #17
  • Loading branch information
hkershaw-brown committed Aug 30, 2024
1 parent 4ec449a commit 4ba4943
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ pip install pydartdiags
## Example importing the obs\_sequence and plots modules

```python
from pydartdiags.obs_sequence import obs_sequence as obs_seq
from pydartdiags.obs_sequence import obs_sequence as obsq
from pydartdiags.plots import plots
```

## Examining the dataframe

```python
obs_seq = obs_seq.obs_sequence('obs_seq.final.ascii')
obs_seq = obsq.obs_sequence('obs_seq.final.ascii')
obs_seq.df.head()
```

Expand Down Expand Up @@ -189,7 +189,7 @@ obs_seq.df.head()
Find the numeber of assimilated (used) observations vs. possible observations by type

```python
obs_seq.possible_vs_used(obs_seq.df)
obsq.possible_vs_used(obs_seq.df)
```

<table border="1" class="dataframe">
Expand Down Expand Up @@ -346,7 +346,7 @@ obs_seq.possible_vs_used(obs_seq.df)
* plot the rank histogram

```python
df_qc0 = obs_seq.select_by_dart_qc(obs_seq.df, 0)
df_qc0 = obsq.select_by_dart_qc(obs_seq.df, 0)
plots.plot_rank_histogram(df_qc0)
```
![Rank Histogram](docs/images/rankhist.png)
Expand All @@ -362,7 +362,7 @@ plots.plot_rank_histogram(df_qc0)
hPalevels = [0.0, 100.0, 150.0, 200.0, 250.0, 300.0, 400.0, 500.0, 700, 850, 925, 1000]# float("inf")] # Pa?
plevels = [i * 100 for i in hPalevels]

df_qc0 = obs_seq.select_by_dart_qc(obs_seq.df, 0) # only qc 0
df_qc0 = obsq.select_by_dart_qc(obs_seq.df, 0) # only qc 0
df_profile, figrmse, figbias = plots.plot_profile(df_qc0, plevels)
```

Expand Down
10 changes: 5 additions & 5 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Import the obs_sequence and plots module

.. code-block :: python
from pydartdiags.obs_sequence import obs_sequence as obs_seq
from pydartdiags.obs_sequence import obs_sequence as obsq
from pydartdiags.plots import plots
Expand All @@ -29,7 +29,7 @@ Read an observation sequence file into a DataFrama

.. code-block :: python
obs_seq = obs_seq.obs_sequence('obs_seq.final.ascii')
obs_seq = obsq.obs_sequence('obs_seq.final.ascii')
Examine the DataFrame
Expand Down Expand Up @@ -199,7 +199,7 @@ Find the numeber of assimilated (used) observations vs. possible observations by

.. code-block :: python
obs_seq.possible_vs_used(obs_seq.df)
obsq.possible_vs_used(obs_seq.df)
.. raw :: html
Expand Down Expand Up @@ -358,7 +358,7 @@ plot a rank histogram

.. code-block :: python
df_qc0 = obs_seq.select_by_dart_qc(obs_seq.df, 0)
df_qc0 = obsq.select_by_dart_qc(obs_seq.df, 0)
plots.plot_rank_histogram(df_qc0)
.. image:: images/rankhist.png
Expand All @@ -376,7 +376,7 @@ plot profiles of RMSE and Bias
hPalevels = [0.0, 100.0, 150.0, 200.0, 250.0, 300.0, 400.0, 500.0, 700, 850, 925, 1000] # Pa?
plevels = [i * 100 for i in hPalevels]
df_qc0 = obs_seq.select_by_dart_qc(obs_seq.df, 0) # only qc 0
df_qc0 = obsq.select_by_dart_qc(obs_seq.df, 0) # only qc 0
df_profile, figrmse, figbias = plots.plot_profile(df_qc0, plevels)
.. image:: images/rmse.png
Expand Down

0 comments on commit 4ba4943

Please sign in to comment.