Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Naming and rewrite the very old ones #38

Merged
merged 26 commits into from
Jun 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
c527ef8
naming convention in utils
MaceKuailv May 29, 2023
7378630
rename topology to Topology
MaceKuailv May 29, 2023
1f9127a
rename position to Position
MaceKuailv May 29, 2023
eb3a1de
rename particle to Particle
MaceKuailv May 29, 2023
8e84eaf
change the confusing keywork argument gridtype and cuvg to cuvwg
MaceKuailv May 29, 2023
98da03f
update the ind_tend_G function with a smart implementation, but it wa…
MaceKuailv May 29, 2023
3c3cddf
ind tend G seems to be working
MaceKuailv May 29, 2023
195a12b
refactor get)combination
MaceKuailv May 29, 2023
72a6313
write find_ind and find_rel not yet tested
MaceKuailv May 29, 2023
6c94d62
test find_rel and find_ind
MaceKuailv May 29, 2023
fa8b544
reduce find_rel_ functions, minor fix on to_next_stop
MaceKuailv May 30, 2023
5c50cd5
use functools.cache to replace global variable
MaceKuailv May 30, 2023
d92ee0e
redo the eval
MaceKuailv May 30, 2023
46c5cce
fix numba type issue, wrestle with eval a little bit
MaceKuailv May 30, 2023
58f0489
address two evals in tests, one more after coming back from symposium
MaceKuailv May 30, 2023
3ec0976
elimilnate the last eval
MaceKuailv May 30, 2023
4b46aad
redo _read_h and find_px_py to reduce repeated code.
MaceKuailv May 30, 2023
6b3b421
put the rel-coordinates into a new Attributeabledict object and refac…
MaceKuailv May 31, 2023
d64a104
The previous version also have the commented out part, this is cleaner
MaceKuailv May 31, 2023
d5b8219
change parameter and return in documentation
MaceKuailv May 31, 2023
3bbd676
change the doc according to numpy standard
MaceKuailv May 31, 2023
f29ea62
remove all __dict__
MaceKuailv May 31, 2023
72b5a7c
before pylint
MaceKuailv May 31, 2023
aa5fcd9
a lot of pylint
MaceKuailv Jun 1, 2023
249c31e
more pylint
MaceKuailv Jun 1, 2023
40db29b
rename R to to_return, revert aliasing legal_tends
MaceKuailv Jun 1, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ latex:
sphinx:
extra_extensions:
- 'sphinx.ext.autodoc'
- 'sphinx.ext.napoleon'
config:
html_theme: sphinx_book_theme
autodoc_member_order: groupwise
Expand Down
2 changes: 1 addition & 1 deletion docs/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ parts:
- file: api_reference/apiref_smartread.rst
- file: api_reference/apiref_getmasks.rst
- file: api_reference/apiref_utils.rst
- file: all_in_one
- file: api_reference/apiref_RelCoord.rst
- caption: Examples
chapters:
- file: Global_ECCO
Expand Down
83 changes: 0 additions & 83 deletions docs/all_in_one.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/api_reference/apiref_OceData.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
seaduck.OceData
------------------------

.. automodule:: seaduck.OceData
.. autoclass:: seaduck.ocedata.OceData
:members:
:undoc-members:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/api_reference/apiref_OceInterp.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
seaduck.OceInterp
--------------------------

.. automodule:: seaduck.OceInterp
.. automodule:: seaduck.oceinterp
:members:
:undoc-members:
:show-inheritance:
24 changes: 24 additions & 0 deletions docs/api_reference/apiref_RelCoord.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
seaduck.ocedata.RelCoord and subclasses
---------------------------------------

.. autoclass:: seaduck.ocedata.RelCoord
:members:
:undoc-members:
:show-inheritance:

Subclasses
----------

.. autoclass:: seaduck.ocedata.HRel

.. autoclass:: seaduck.ocedata.VRel

.. autoclass:: seaduck.ocedata.VLinRel

.. autoclass:: seaduck.ocedata.VlRel

.. autoclass:: seaduck.ocedata.VlLinRel

.. autoclass:: seaduck.ocedata.TRel

.. autoclass:: seaduck.ocedata.TLinRel
2 changes: 0 additions & 2 deletions docs/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,3 @@
[smart_read](api_reference/apiref_smartread.rst)
[get_masks](api_reference/apiref_getmasks.rst)
[utils](api_reference/apiref_utils.rst)

### [All in one page](all_in_one)
12 changes: 6 additions & 6 deletions seaduck/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,21 @@
# Local copy or not installed with setuptools
__version__ = "999"

from seaduck.eulerian import position
from seaduck.eulerian import Position
from seaduck.kernel_weight import KnW
from seaduck.lagrangian import particle
from seaduck.lagrangian import Particle
from seaduck.ocedata import OceData
from seaduck.oceinterp import OceInterp
from seaduck.runtime_conf import rcParam
from seaduck.topology import topology
from seaduck.topology import Topology

__all__ = [
"__version__",
"position",
"Position",
"KnW",
"particle",
"Particle",
"OceData",
"OceInterp",
"rcParam",
"topology",
"Topology",
]
Loading