diff --git a/.coveragerc b/.coveragerc
index 17202717..05f70a81 100644
--- a/.coveragerc
+++ b/.coveragerc
@@ -6,5 +6,5 @@ exclude_lines =
pragma: no cover
raise NotImplementedError
omit = seaduck/__init__.py
- doc/*
+ docs/*
tests/*
diff --git a/.gitignore b/.gitignore
index 6d14d4b6..61821fd0 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,16 +1,361 @@
-# notebooks
+# setuptools-scm
+version.py
+
+# Sphinx automatic generation of API
+docs/_api/
+
+# Created by https://www.toptal.com/developers/gitignore/api/python,jupyternotebooks,vim,visualstudiocode,pycharm
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,jupyternotebooks,vim,visualstudiocode,pycharm
+
+### JupyterNotebooks ###
+# gitignore template for Jupyter Notebooks
+# website: http://jupyter.org/
+
+.ipynb_checkpoints
+*/.ipynb_checkpoints/*
+
+# IPython
+profile_default/
+ipython_config.py
+
+# Remove previous ipynb_checkpoints
+# git rm -r .ipynb_checkpoints/
+
+### PyCharm ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn. Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### PyCharm Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml
+# *.ipr
+
+# Sonarlint plugin
+# https://plugins.jetbrains.com/plugin/7973-sonarlint
+.idea/**/sonarlint/
+
+# SonarQube Plugin
+# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
+.idea/**/sonarIssues.xml
+
+# Markdown Navigator plugin
+# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
+.idea/**/markdown-navigator.xml
+.idea/**/markdown-navigator-enh.xml
+.idea/**/markdown-navigator/
+
+# Cache file creation bug
+# See https://youtrack.jetbrains.com/issue/JBR-2257
+.idea/$CACHE_FILE$
+
+# CodeStream plugin
+# https://plugins.jetbrains.com/plugin/12206-codestream
+.idea/codestream.xml
+
+# Azure Toolkit for IntelliJ plugin
+# https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij
+.idea/**/azureSettings.xml
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+# Usually these files are written by a python script from a template
+# before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+
+# IPython
+
+# pyenv
+# For a library or package, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+# However, in case of collaboration, if having platform-specific dependencies or dependencies
+# having no cross-platform support, pipenv may install dependencies that don't work, or not
+# install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+# This is especially recommended for binary packages to ensure reproducibility, and is more
+# commonly ignored for libraries.
+# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+# in version control.
+# https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+# and can be added to the global gitignore or merged into this file. For a more nuclear
+# option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+### Vim ###
+# Swap
+[._]*.s[a-v][a-z]
+!*.svg # comment out if you don't need vector files
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+
+# Session
+Session.vim
+Sessionx.vim
+
+# Temporary
+.netrwhist
+*~
+# Auto-generated tag files
+tags
+# Persistent undo
+[._]*.un~
+
+### VisualStudioCode ###
+.vscode/
+# .vscode/*
+# !.vscode/settings.json
+# !.vscode/tasks.json
+# !.vscode/launch.json
+# !.vscode/extensions.json
+# !.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+# Ignore code-workspaces
+*.code-workspace
+
+# User Defined
test*.ipynb
-*ipy*/
-*.pyc
*.npy
*.png
*.jpg
.vscode/
-.coverage
-.pytest*
-dist/
-build/
-seaduck.egg-info/
-tests/Data/
tests/Data
assets/
+*.pyc
+*.nc
+
+# End of https://www.toptal.com/developers/gitignore/api/python,jupyternotebooks,vim,visualstudiocode,pycharm
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 7fc316fa..8fde9f4c 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -1,16 +1,33 @@
-# https://pre-commit.com/
-ci:
- autofix_prs: false
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.4.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
+ - id: check-json
- id: check-yaml
+ - id: check-toml
- id: check-added-large-files
- id: debug-statements
- id: mixed-line-ending
+- repo: https://github.com/psf/black
+ rev: 23.3.0
+ hooks:
+ - id: black
+- repo: https://github.com/keewis/blackdoc
+ rev: v0.3.8
+ hooks:
+ - id: blackdoc
+ additional_dependencies: [black==22.3.0]
+- repo: https://github.com/charliermarsh/ruff-pre-commit
+ rev: v0.0.265
+ hooks:
+ - id: ruff
+ args: [--fix, '--exclude=tests/*', '--exclude=seaduck/__init__.py']
+- repo: https://github.com/executablebooks/mdformat
+ rev: 0.7.16
+ hooks:
+ - id: mdformat
- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
rev: v2.8.0
hooks:
@@ -18,18 +35,3 @@ repos:
args: [--autofix, --preserve-quotes]
- id: pretty-format-toml
args: [--autofix]
-- repo: https://github.com/pycqa/isort
- rev: 5.12.0
- hooks:
- - id: isort
-- repo: https://github.com/PyCQA/flake8
- rev: 6.0.0
- hooks:
- - id: flake8
- exclude: seaduck/__init__.py
- args: ['--ignore=E501,E231', '--exclude=tests/*']
-- repo: https://github.com/nbQA-dev/nbQA
- rev: 1.7.0
- hooks:
- - id: nbqa-isort
- additional_dependencies: [isort]
diff --git a/.pre-commit-config_loose.yaml b/.pre-commit-config_loose.yaml
new file mode 100644
index 00000000..7fc316fa
--- /dev/null
+++ b/.pre-commit-config_loose.yaml
@@ -0,0 +1,35 @@
+# https://pre-commit.com/
+ci:
+ autofix_prs: false
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+ rev: v4.4.0
+ hooks:
+ - id: trailing-whitespace
+ - id: end-of-file-fixer
+ - id: check-yaml
+ - id: check-added-large-files
+ - id: debug-statements
+ - id: mixed-line-ending
+- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
+ rev: v2.8.0
+ hooks:
+ - id: pretty-format-yaml
+ args: [--autofix, --preserve-quotes]
+ - id: pretty-format-toml
+ args: [--autofix]
+- repo: https://github.com/pycqa/isort
+ rev: 5.12.0
+ hooks:
+ - id: isort
+- repo: https://github.com/PyCQA/flake8
+ rev: 6.0.0
+ hooks:
+ - id: flake8
+ exclude: seaduck/__init__.py
+ args: ['--ignore=E501,E231', '--exclude=tests/*']
+- repo: https://github.com/nbQA-dev/nbQA
+ rev: 1.7.0
+ hooks:
+ - id: nbqa-isort
+ additional_dependencies: [isort]
diff --git a/LICENSE b/LICENSE
index 48f56141..f334c1bb 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,21 +1,201 @@
-MIT License
-
-Copyright (c) 2022, Wenrui Jiang
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright 2023, Wenrui Jiang.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/Makefile b/Makefile
new file mode 100644
index 00000000..cb6705ed
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,25 @@
+PROJECT := seaduck
+CONDA := conda
+CONDAFLAGS :=
+COV_REPORT := term-missing
+
+default: qa unit-tests type-check
+
+qa:
+ pre-commit run --all-files
+
+unit-tests:
+ python -m pytest -vv --cov=seaduck --cov-report=$(COV_REPORT) --doctest-glob="*.md" --doctest-glob="*.rst"
+
+type-check:
+ python -m mypy .
+
+conda-env-update:
+ $(CONDA) env update $(CONDAFLAGS) -f ci/environment-ci.yml
+ $(CONDA) env update $(CONDAFLAGS) -f environment.yml
+
+
+docs-build:
+ jupyter-book build docs/
+
+# DO NOT EDIT ABOVE THIS LINE, ADD COMMANDS BELOW
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..d0bd7ba0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,47 @@
+# seaduck
+
+A python package that interpolates data from ocean dataset from both Eulerian and Lagrangian perspective.
+
+## Quick Start
+
+```python
+>>> import seaduck
+
+```
+
+## Workflow for developers/contributors
+
+For best experience create a new conda environment (e.g. DEVELOP) with Python 3.10:
+
+```
+conda create -n DEVELOP -c conda-forge python=3.10
+conda activate DEVELOP
+```
+
+Before pushing to GitHub, run the following commands:
+
+1. Update conda environment: `make conda-env-update`
+1. Install this package: `pip install -e .`
+1. Sync with the latest [template](https://github.com/ecmwf-projects/cookiecutter-conda-package) (optional): `make template-update`
+1. Run quality assurance checks: `make qa`
+1. Run tests: `make unit-tests`
+1. Run the static type checker: `make type-check`
+1. Build the documentation (see [Sphinx tutorial](https://www.sphinx-doc.org/en/master/tutorial/)): `make docs-build`
+
+## License
+
+```
+Copyright 2023, Wenrui Jiang.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```
diff --git a/ci/environment-ci.yml b/ci/environment-ci.yml
new file mode 100644
index 00000000..6688eeec
--- /dev/null
+++ b/ci/environment-ci.yml
@@ -0,0 +1,16 @@
+# environment-ci.yml: Additional dependencies to install in the CI environment.
+channels:
+- conda-forge
+- nodefaults
+dependencies:
+- make
+- mypy
+- myst-parser
+- pre-commit
+- pydata-sphinx-theme
+- pytest
+- pytest-cov
+- sphinx
+- sphinx-autoapi
+- pooch
+- zarr
diff --git a/ci/environment-integration.yml b/ci/environment-integration.yml
new file mode 100644
index 00000000..6a8511d3
--- /dev/null
+++ b/ci/environment-integration.yml
@@ -0,0 +1,9 @@
+# environment-integration.yml: Additional dependencies to install in the integration environment (e.g., pinned dependencies).
+channels:
+- conda-forge
+- nodefaults
+dependencies:
+- make
+- pytest
+- pytest-cov
+# DO NOT EDIT ABOVE THIS LINE, ADD DEPENDENCIES BELOW
diff --git a/docs/_build/.doctrees/AVISO.doctree b/docs/_build/.doctrees/AVISO.doctree
index 5c20cedc..cdf2a4d0 100644
Binary files a/docs/_build/.doctrees/AVISO.doctree and b/docs/_build/.doctrees/AVISO.doctree differ
diff --git a/docs/_build/.doctrees/Global_ECCO.doctree b/docs/_build/.doctrees/Global_ECCO.doctree
index c8a4433b..4069d946 100644
Binary files a/docs/_build/.doctrees/Global_ECCO.doctree and b/docs/_build/.doctrees/Global_ECCO.doctree differ
diff --git a/docs/_build/.doctrees/IGP.doctree b/docs/_build/.doctrees/IGP.doctree
index 29ed2ef3..1727a929 100644
Binary files a/docs/_build/.doctrees/IGP.doctree and b/docs/_build/.doctrees/IGP.doctree differ
diff --git a/docs/_build/.doctrees/all_in_one.doctree b/docs/_build/.doctrees/all_in_one.doctree
index fc7418a2..30c88e09 100644
Binary files a/docs/_build/.doctrees/all_in_one.doctree and b/docs/_build/.doctrees/all_in_one.doctree differ
diff --git a/docs/_build/.doctrees/api_reference/apiref_OceData.doctree b/docs/_build/.doctrees/api_reference/apiref_OceData.doctree
index f2b562ed..3cbcd96d 100644
Binary files a/docs/_build/.doctrees/api_reference/apiref_OceData.doctree and b/docs/_build/.doctrees/api_reference/apiref_OceData.doctree differ
diff --git a/docs/_build/.doctrees/api_reference/apiref_OceInterp.doctree b/docs/_build/.doctrees/api_reference/apiref_OceInterp.doctree
index 4d5b2e44..f536688a 100644
Binary files a/docs/_build/.doctrees/api_reference/apiref_OceInterp.doctree and b/docs/_build/.doctrees/api_reference/apiref_OceInterp.doctree differ
diff --git a/docs/_build/.doctrees/api_reference/apiref_eulerian.doctree b/docs/_build/.doctrees/api_reference/apiref_eulerian.doctree
index 2acc69c1..86c80327 100644
Binary files a/docs/_build/.doctrees/api_reference/apiref_eulerian.doctree and b/docs/_build/.doctrees/api_reference/apiref_eulerian.doctree differ
diff --git a/docs/_build/.doctrees/api_reference/apiref_getmasks.doctree b/docs/_build/.doctrees/api_reference/apiref_getmasks.doctree
index 27ead327..994d3a9f 100644
Binary files a/docs/_build/.doctrees/api_reference/apiref_getmasks.doctree and b/docs/_build/.doctrees/api_reference/apiref_getmasks.doctree differ
diff --git a/docs/_build/.doctrees/api_reference/apiref_kernelNweight.doctree b/docs/_build/.doctrees/api_reference/apiref_kernelNweight.doctree
index 09d0652f..74d60bcb 100644
Binary files a/docs/_build/.doctrees/api_reference/apiref_kernelNweight.doctree and b/docs/_build/.doctrees/api_reference/apiref_kernelNweight.doctree differ
diff --git a/docs/_build/.doctrees/api_reference/apiref_lagrangian.doctree b/docs/_build/.doctrees/api_reference/apiref_lagrangian.doctree
index e6ee2348..56efd80c 100644
Binary files a/docs/_build/.doctrees/api_reference/apiref_lagrangian.doctree and b/docs/_build/.doctrees/api_reference/apiref_lagrangian.doctree differ
diff --git a/docs/_build/.doctrees/api_reference/apiref_smartread.doctree b/docs/_build/.doctrees/api_reference/apiref_smartread.doctree
index 4a3ad863..4a4c0b7f 100644
Binary files a/docs/_build/.doctrees/api_reference/apiref_smartread.doctree and b/docs/_build/.doctrees/api_reference/apiref_smartread.doctree differ
diff --git a/docs/_build/.doctrees/api_reference/apiref_topology.doctree b/docs/_build/.doctrees/api_reference/apiref_topology.doctree
index cd02e827..e0e9ff69 100644
Binary files a/docs/_build/.doctrees/api_reference/apiref_topology.doctree and b/docs/_build/.doctrees/api_reference/apiref_topology.doctree differ
diff --git a/docs/_build/.doctrees/api_reference/apiref_utils.doctree b/docs/_build/.doctrees/api_reference/apiref_utils.doctree
index 8b69fed7..b021aa51 100644
Binary files a/docs/_build/.doctrees/api_reference/apiref_utils.doctree and b/docs/_build/.doctrees/api_reference/apiref_utils.doctree differ
diff --git a/docs/_build/.doctrees/environment.pickle b/docs/_build/.doctrees/environment.pickle
index b118c3d2..9e63f134 100644
Binary files a/docs/_build/.doctrees/environment.pickle and b/docs/_build/.doctrees/environment.pickle differ
diff --git a/docs/_build/.doctrees/how_to_install.doctree b/docs/_build/.doctrees/how_to_install.doctree
index c98b66ce..86371862 100644
Binary files a/docs/_build/.doctrees/how_to_install.doctree and b/docs/_build/.doctrees/how_to_install.doctree differ
diff --git a/docs/_build/.doctrees/intro.doctree b/docs/_build/.doctrees/intro.doctree
index 5888a276..6b3ddf36 100644
Binary files a/docs/_build/.doctrees/intro.doctree and b/docs/_build/.doctrees/intro.doctree differ
diff --git a/docs/_build/.doctrees/network_of_object.doctree b/docs/_build/.doctrees/network_of_object.doctree
index 7add5f96..8dc25144 100644
Binary files a/docs/_build/.doctrees/network_of_object.doctree and b/docs/_build/.doctrees/network_of_object.doctree differ
diff --git a/docs/_build/.doctrees/notebooks.doctree b/docs/_build/.doctrees/notebooks.doctree
index 136cd253..8e49b3da 100644
Binary files a/docs/_build/.doctrees/notebooks.doctree and b/docs/_build/.doctrees/notebooks.doctree differ
diff --git a/docs/_build/.doctrees/reference.doctree b/docs/_build/.doctrees/reference.doctree
index ebe4747b..a5dd702f 100644
Binary files a/docs/_build/.doctrees/reference.doctree and b/docs/_build/.doctrees/reference.doctree differ
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
index cc43991a..c79cdc53 100644
--- a/docs/_build/html/.buildinfo
+++ b/docs/_build/html/.buildinfo
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: f20fc3726dda287102af480ecaf1105c
+config: fb9519fbfb7ec29c95cb5a8de394b512
tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/AVISO.html b/docs/_build/html/AVISO.html
index f533d200..4a8d9f31 100644
--- a/docs/_build/html/AVISO.html
+++ b/docs/_build/html/AVISO.html
@@ -135,13 +135,7 @@
-
-
-
-
- 
-
-
+ My sample book