{"id":13780615,"url":"https://github.com/akarimp/oceanlyz","last_synced_at":"2025-05-11T13:32:43.236Z","repository":{"id":185708094,"uuid":"196758737","full_name":"akarimp/Oceanlyz","owner":"akarimp","description":"OCEANLYZ, Ocean Wave Analyzing Toolbox","archived":false,"fork":false,"pushed_at":"2023-08-11T18:51:28.000Z","size":3493,"stargazers_count":20,"open_issues_count":0,"forks_count":13,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-26T11:02:05.254Z","etag":null,"topics":["coastal-engineering","metocean","oceanography"],"latest_commit_sha":null,"homepage":"http://www.arashkarimpour.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/akarimp.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2019-07-13T19:26:28.000Z","updated_at":"2024-04-05T18:17:23.000Z","dependencies_parsed_at":null,"dependency_job_id":"70b43e46-7ba7-49c1-9714-f30ad90624b4","html_url":"https://github.com/akarimp/Oceanlyz","commit_stats":{"total_commits":222,"total_committers":1,"mean_commits":222.0,"dds":0.0,"last_synced_commit":"cf7f1a615be5d6bd04131e1dbc760892349e5f08"},"previous_names":["akarimp/oceanlyz"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akarimp%2FOceanlyz","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akarimp%2FOceanlyz/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akarimp%2FOceanlyz/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akarimp%2FOceanlyz/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/akarimp","download_url":"https://codeload.github.com/akarimp/Oceanlyz/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225056844,"owners_count":17414222,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["coastal-engineering","metocean","oceanography"],"created_at":"2024-08-03T18:01:17.869Z","updated_at":"2024-11-17T15:31:21.958Z","avatar_url":"https://github.com/akarimp.png","language":"Python","funding_links":[],"categories":["By topic"],"sub_categories":["Wave modelling"],"readme":".. YA LATIF\r\n\r\nOCEANLYZ\r\n========\r\n\r\nOCEANLYZ, Ocean Wave Analyzing Toolbox, is a toolbox for analyzing the wave time series data collected by sensors in open body of water such as ocean, sea, and lake or in a laboratory.\r\n\r\nOCEANLYZ GUI is a graphical user interface for the OCEANLYZ toolbox.\r\n\r\nThis toolbox provides spectral and zero-crossing wave analysis. It can calculate wave properties such as zero-moment wave height, significant wave height, mean wave height, peak wave period and mean period. This toolbox can correct and account for the pressure attention (pressure loss) in the water column for data collected by a pressure sensor. This toolbox can separate wind sea and swell energies and reports their properties.\r\n\r\n:Name: OCEANLYZ\r\n:Description: Ocean Wave Analyzing Toolbox\r\n:Version: 2.0 (GUI 1.2)\r\n:Requirements: MATLAB or GNU Octave | Python (3 or later) | GUI Version (Microsoft Windows 10 (64-bit))\r\n:Developer: Arash Karimpour | https://www.arashkarimpour.com\r\n:Documentation: https://oceanlyz.readthedocs.io\r\n:Tutorial Video: `YouTube Playlist \u003chttps://www.youtube.com/playlist?list=PLcrFHi9M_GZRTCshcgujlK7y5ZPim6afM\u003e`_\r\n:Source Code: https://github.com/akarimp/Oceanlyz\r\n:Report Issues: https://github.com/akarimp/Oceanlyz/issues\r\n\r\nGUI Version\r\n===========\r\n\r\nInstalling (GUI Version)\r\n------------------------\r\n\r\nTo use stand-alone GUI version of OCEANLYZ (Microsoft Windows (64-bit)):\r\n\r\n* Download OCEANLYZ GUI setup file:\r\n\r\n    * Version 1.2 (GitHub): https://github.com/akarimp/Oceanlyz/releases/download/2.0/oceanlyz_gui_1.2_win_x64_setup.exe\r\n\r\n* Run setup file and follow setup wizard to install OCEANLYZ GUI\r\n* Start OCEANLYZ GUI\r\n* For documentation, use Help menu in OCEANLYZ GUI\r\n\r\nMATLAB Version\r\n==============\r\n\r\nInstalling (MATLAB)\r\n-------------------\r\n\r\nTo use MATLAB version of OCEANLYZ toolbox:\r\n\r\n* Install MATLAB or GNU Octave\r\n\r\n    * MATLAB: https://www.mathworks.com\r\n    * GNU Octave: https://octave.org\r\n\r\n* Download OCEANLYZ:\r\n\r\n    * Version 2.0 (GitHub): https://github.com/akarimp/Oceanlyz/releases/download/2.0/oceanlyz_2_0.zip\r\n    * Version 1.5 (CNET): https://download.cnet.com/Oceanlyz/3000-2054_4-75833686.html\r\n    * Version 1.5 (GitHub): https://github.com/akarimp/Oceanlyz/releases/download/1.5/oceanlyz_1_5.zip\r\n    * Version 1.4 (GitHub): https://github.com/akarimp/Oceanlyz/releases/download/1.5/oceanlyz_1_4.zip\r\n\r\n* Unzip OCEANLYZ in any location you choose such as “C:\\\\”\r\n* Add OCEANLYZ folder to MATLAB or GNU Octave path\r\n\r\nAdd OCEANLYZ folder to MATLAB or GNU Octave path\r\n------------------------------------------------\r\n\r\nFor example, if OCEANLYZ files are in \"C:\\\\OCEANLYZ\" folder, then:\r\n\r\nTo add OCEANLYZ to MATLAB or GNU Octave path, run following commands in the Command Window:\r\n\r\n.. code:: MATLAB\r\n\r\n    OceanlyzPath = genpath('C:\\oceanlyz'); %Generating path for OCEANLYZ folder and its sub-folders\r\n    addpath(OceanlyzPath); %Add OCEANLYZ folder to path\r\n\r\nRequired Package for MATLAB\r\n---------------------------\r\n\r\nMATLAB users need to install MATLAB Signal Processing Toolbox (https://www.mathworks.com/products/signal.html) for running the OCEANLYZ spectral analysis. It gives OCEANLYZ access to MATLAB Welch's power spectral density calculation. However, MATLAB Signal Processing Toolbox is not required for zero-crossing analysis. \r\n\r\nRequired Package for GNU Octave\r\n-------------------------------\r\n\r\nGNU Octave users need to install/load GNU Octave Signal package (https://gnu-octave.github.io/packages/signal) for running the OCEANLYZ spectral analysis.\r\nIt gives OCEANLYZ access to GNU Octave Welch's power spectral density calculation. However, GNU Octave Signal package is not required for zero-crossing analysis.\r\nTo find the list of the GNU Octave's pre-installed packages, run the following command in the Command Window:\r\n\r\n.. code:: octave\r\n    \r\n    \u003e\u003e pkg list\r\n\r\nGNU Octave comes with Signal package but it needs to loaded every time GNU Octave starts. The Signal package can be loaded inside GNU Octave by running the following command in the Command Window (This should be done every time GNU Octave is opened):\r\n\r\n.. code:: octave\r\n    \r\n    \u003e\u003e pkg load signal\r\n\r\n\r\nIf GNU Octave Signal Package is not already installed, it should be first installed from https://packages.octave.org, and then get loaded by running the following commands in the Command Window:\r\n\r\n.. code:: octave\r\n\r\n    \u003e\u003e pkg install \"https://downloads.sourceforge.net/project/octave/Octave%20Forge%20Packages/Individual%20Package%20Releases/signal-1.4.5.tar.gz\"\r\n    \u003e\u003e pkg load signal\r\n\r\nQuick Start (MATLAB)\r\n--------------------\r\n\r\n* Open MATLAB or GNU Octave\r\n* Change a current folder (current directory) to a folder that contains OCEANLYZ toolbox, for example “C:\\\\oceanlyz”, in MATLAB or GNU Octave.\r\n* Open a file named “oceanlyzinput.m” in MATLAB or GNU Octave editor and modify it based on the properties of the collected dataset and required analysis.\r\n* Run a file named “RunOceanlyz.m” in MATLAB or GNU Octave to start calculations.\r\n\r\nPython Version\r\n==============\r\n\r\nInstalling (Python)\r\n-------------------\r\n\r\nTo use Python version of OCEANLYZ toolbox:\r\n\r\n* Install Python\r\n* Install OCEANLYZ\r\n\r\n**1) Install Python**\r\n\r\nFirst, we need to install Python programming language.\r\n\r\n* Method 1:\r\n    Install Python from https://www.python.org and then use the **pip** command to install required packages\r\n* Method 2 (Recommended):\r\n    Install Anaconda Python distribution from https://www.anaconda.com and then use the **conda** command to install required packages\r\n\r\n**2) Install OCEANLYZ**\r\n\r\nAfter Python is installed, you need to install OCEANLYZ package.\r\n\r\nIf you installed Python, then you need to install OCEANLYZ via pip (https://pypi.org/project/oceanlyz). To do that, open the Command Prompt (or Terminal) and run:\r\n\r\n.. code:: python\r\n\r\n    pip install oceanlyz\r\n\r\nIf you installed Anaconda Python distribution, then you need to install OCEANLYZ via Anaconda cloud (https://anaconda.org/akarimp/oceanlyz). To do that, open the Command Prompt (or Terminal) and run:\r\n\r\n.. code:: python\r\n\r\n    conda install -c akarimp oceanlyz\r\n\r\nRequired Package for Python\r\n---------------------------\r\n\r\nFollowing packages are required:\r\n\r\n* NumPy (https://numpy.org)\r\n* SciPy (https://www.scipy.org)\r\n* Matplotlib (https://matplotlib.org)\r\n\r\nQuick Start (Python)\r\n--------------------\r\n\r\n* Open Python\r\n* Import OCEANLYZ package by using \"import oceanlyz\" \r\n* Create OCEANLYZ object such as “ocn=oceanlyz.oceanlyz()” in Python and set/modify its properties based on the dataset and required analysis.\r\n* Run a method as “ocn.runoceanlyz()” in Python to start calculations.\r\n\r\nAbout\r\n=====\r\n\r\nOperating System\r\n----------------\r\n\r\nOCEANLYZ code can be run on Microsoft Windows, Mac, and Linux. However, make sure any given path is compatible with a running operating system. In particular, “\\\\” is used in Windows path, while “/” is used in Mac or Linux path. For example, if a path is “C:\\\\” on Windows machine, it would be “C:/” on Mac or Linux.\r\n\r\nOCEANLYZ GUI can be run on Microsoft Windows (64-bit) machine.\r\n\r\nRequired Programming Language\r\n-----------------------------\r\n\r\nOCEANLYZ toolbox can be run by using MATLAB (https://www.mathworks.com), GNU Octave (https://octave.org), or Python (https://www.python.org). \r\n\r\nCitation\r\n--------\r\n\r\nCite OCEANLYZ as:\r\n\r\nKarimpour, A., \u0026 Chen, Q. (2017). Wind Wave Analysis in Depth Limited Water Using OCEANLYZ, a MATLAB toolbox. Computers \u0026 Geosciences.\r\n\r\nLink: https://www.sciencedirect.com/science/article/pii/S0098300417306489\r\n\r\nRecommended Books\r\n-----------------\r\n\r\n.. list-table::\r\n   :header-rows: 1\r\n   :align: center\r\n\r\n   * - .. figure:: figures/Figure_Book_Coastal.jpg\r\n     - .. figure:: figures/Figure_Book_Matlab.jpg\r\n     - .. figure:: figures/Figure_Book_Python.jpg\r\n\r\n   * - | **Ocean Wave Data Analysis**\r\n       | Introduction to Time Series Analysis, Signal Processing, and Wave Prediction.\r\n       |\r\n       | Order at Amazon: https://www.amazon.com/dp/0692109978\r\n       |\r\n       | Read Online: https://github.com/akarimp/Ocean-Wave-Data-Analysis\r\n     - | **Fundamentals of Data Science with MATLAB**\r\n       | Introduction to Scientific Computing, Data Analysis, and Data Visualization.\r\n       |\r\n       | Order at Amazon: https://www.amazon.com/dp/1735241016\r\n       |\r\n       | Read Online: https://github.com/akarimp/Fundamentals-of-Data-Science-with-MATLAB\r\n     - | **Principles of Data Science with Python**\r\n       | Introduction to Scientific Computing, Data Analysis, and Data Visualization.\r\n       |\r\n       | Order at Amazon: https://www.amazon.com/dp/1735241008\r\n       |\r\n       | Read Online: https://github.com/akarimp/Principles-of-Data-Science-with-Python\r\n\r\nRecommended Applications\r\n------------------------\r\n\r\n.. list-table::\r\n   :header-rows: 1\r\n   :align: center\r\n\r\n   * - .. figure:: figures/Figure_Oceanlyz_Logo.png\r\n     - .. figure:: figures/Figure_ScientiMate_Logo.png\r\n     - .. figure:: figures/Figure_AsanPlot_Screenshot.jpg\r\n\r\n   * - | **OCEANLYZ**\r\n       | Ocean Wave Analyzing Toolbox\r\n       |\r\n       | Download: https://github.com/akarimp/Oceanlyz\r\n     - | **ScientiMate**\r\n       | Coastal and Ocean Data Analysis Library\r\n       |\r\n       | Download: https://github.com/akarimp/ScientiMate\r\n     - | **AsanPlot**\r\n       | Data cleaning and plotting software\r\n       |\r\n       | Download: https://github.com/akarimp/AsanPlot\r\n\r\nLicense Agreement and Disclaimer\r\n--------------------------------\r\n\r\nOCEANLYZ: Ocean Wave Analyzing Toolbox\r\n\r\nCopyright (c) 2023 Arash Karimpour\r\n\r\nAll rights reserved\r\n\r\nPermission is hereby granted, free of charge, to any person obtaining a copy\r\nof this software and associated documentation files (the \"Software\"), to deal\r\nin the Software without restriction, including without limitation the rights\r\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r\ncopies of the Software, and to permit persons to whom the Software is\r\nfurnished to do so, subject to the following conditions:\r\n\r\nThe above copyright notice and this permission notice shall be included in all\r\ncopies or substantial portions of the Software.\r\n\r\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\r\nSOFTWARE.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakarimp%2Foceanlyz","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fakarimp%2Foceanlyz","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakarimp%2Foceanlyz/lists"}