wassfast


Namewassfast JSON
Version 1.5.4 PyPI version JSON
download
home_page
SummaryThe next-generation stereo processing pipeline for sea waves 3D reconstruction.
upload_time2023-11-19 22:02:30
maintainer
docs_urlNone
authorFilippo Bergamasco
requires_python>=3.8
licenseGPL3
keywords wass 3d sea-waves
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            WASSfast is the next-generation stereo processing pipeline for sea waves 3D reconstruction. It exploits the linear dispertion relation and sparse feature triangulation to resolve sea-surface elevation in quasi real-time. At present state, WASSfast can work in two operating modes:

1) Predict-Update (PU) mode. See the [paper](https://www.sciencedirect.com/science/article/pii/S0098300420306385)

2) Convolutional Neural Network (CNN) mode (suggested). See the [paper](https://www.mdpi.com/2072-4292/13/18/3780/pdf)


For the standard pipeline see [http://www.dais.unive.it/wass](http://www.dais.unive.it/wass)

**Note** Due to TensorFlow version incompatibilities, WASSfast installed via Pypi supports CNN mode only.

## How to use it

Install via pip:

```
python -m pip install wassfast
```

and run `wassfast --help` for a brief description of the command-line options.


## Try it with test data

1. Download the [test data](https://www.dais.unive.it/wass/wassfast_testdata_256.7z)
2. Extract the test data ```7z x wassfast_testdata_256.7z```. This will create
   a directory named `wassfast_testdata_256`
3. Enter the newly extracted directory: `cd wassfast_testdata_256`
4. Execute WASSfast:

```
wassfast ./input ./config256.mat ./config ./settings.cfg RLTB CNN --batchsize 16 -n 49 -r 15.0 -o output.nc 
```

After the processing, the NetCDF file `output.nc` is produced. Use [Panoply](https://www.giss.nasa.gov/tools/panoply/) to inspect the reconstructed surface.


## Acknowledgements

The study was partially supported by the project of Construction of Ocean Research Stations and their Application Studies funded by the Ministry of Oceans and Fisheries, Republic of Korea.


## License

```
Copyright (C) 2020-2023 Filippo Bergamasco 

WASSfast is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

WASSfast is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "wassfast",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "WASS,3D,Sea-waves",
    "author": "Filippo Bergamasco",
    "author_email": "filippo.bergamasco@unive.it",
    "download_url": "https://files.pythonhosted.org/packages/1e/16/291298970b858af8ad94e676cffa3a84e219e6df120e5593febf2296f6d1/wassfast-1.5.4.tar.gz",
    "platform": null,
    "description": "WASSfast is the next-generation stereo processing pipeline for sea waves 3D reconstruction. It exploits the linear dispertion relation and sparse feature triangulation to resolve sea-surface elevation in quasi real-time. At present state, WASSfast can work in two operating modes:\n\n1) Predict-Update (PU) mode. See the [paper](https://www.sciencedirect.com/science/article/pii/S0098300420306385)\n\n2) Convolutional Neural Network (CNN) mode (suggested). See the [paper](https://www.mdpi.com/2072-4292/13/18/3780/pdf)\n\n\nFor the standard pipeline see [http://www.dais.unive.it/wass](http://www.dais.unive.it/wass)\n\n**Note** Due to TensorFlow version incompatibilities, WASSfast installed via Pypi supports CNN mode only.\n\n## How to use it\n\nInstall via pip:\n\n```\npython -m pip install wassfast\n```\n\nand run `wassfast --help` for a brief description of the command-line options.\n\n\n## Try it with test data\n\n1. Download the [test data](https://www.dais.unive.it/wass/wassfast_testdata_256.7z)\n2. Extract the test data ```7z x wassfast_testdata_256.7z```. This will create\n   a directory named `wassfast_testdata_256`\n3. Enter the newly extracted directory: `cd wassfast_testdata_256`\n4. Execute WASSfast:\n\n```\nwassfast ./input ./config256.mat ./config ./settings.cfg RLTB CNN --batchsize 16 -n 49 -r 15.0 -o output.nc \n```\n\nAfter the processing, the NetCDF file `output.nc` is produced. Use [Panoply](https://www.giss.nasa.gov/tools/panoply/) to inspect the reconstructed surface.\n\n\n## Acknowledgements\n\nThe study was partially supported by the project of Construction of Ocean Research Stations and their Application Studies funded by the Ministry of Oceans and Fisheries, Republic of Korea.\n\n\n## License\n\n```\nCopyright (C) 2020-2023 Filippo Bergamasco \n\nWASSfast is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nWASSfast is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program.  If not, see <http://www.gnu.org/licenses/>.\n```\n",
    "bugtrack_url": null,
    "license": "GPL3",
    "summary": "The next-generation stereo processing pipeline for sea waves 3D reconstruction.",
    "version": "1.5.4",
    "project_urls": {
        "homepage": "https://sites.google.com/unive.it/wass",
        "repository": "https://gitlab.com/fibe/wassfast"
    },
    "split_keywords": [
        "wass",
        "3d",
        "sea-waves"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4b57510abb18d9ca3ef9871443637b1bb44980373b5646ebc9ef195f83652375",
                "md5": "79754592ceadb81039d09753e00ab1a0",
                "sha256": "abfa872b67d2f5370166ec88ba2acee04d0a47e8f0e71b81ba20f1e90ec0a0f3"
            },
            "downloads": -1,
            "filename": "wassfast-1.5.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "79754592ceadb81039d09753e00ab1a0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 21818225,
            "upload_time": "2023-11-19T22:02:25",
            "upload_time_iso_8601": "2023-11-19T22:02:25.214897Z",
            "url": "https://files.pythonhosted.org/packages/4b/57/510abb18d9ca3ef9871443637b1bb44980373b5646ebc9ef195f83652375/wassfast-1.5.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1e16291298970b858af8ad94e676cffa3a84e219e6df120e5593febf2296f6d1",
                "md5": "5085839acce80121ec2a79dd106c64f4",
                "sha256": "b82adc2f7de23a3c8419e99220c28ac31b80f7f6af2b598df1578af5613468b8"
            },
            "downloads": -1,
            "filename": "wassfast-1.5.4.tar.gz",
            "has_sig": false,
            "md5_digest": "5085839acce80121ec2a79dd106c64f4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 25923304,
            "upload_time": "2023-11-19T22:02:30",
            "upload_time_iso_8601": "2023-11-19T22:02:30.470084Z",
            "url": "https://files.pythonhosted.org/packages/1e/16/291298970b858af8ad94e676cffa3a84e219e6df120e5593febf2296f6d1/wassfast-1.5.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-19 22:02:30",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "fibe",
    "gitlab_project": "wassfast",
    "lcname": "wassfast"
}
        
Elapsed time: 0.15522s