From e9f5dc14435844ad989547264da3cdad0ad483b9 Mon Sep 17 00:00:00 2001 From: ibarraespinosa Date: Thu, 20 Feb 2025 09:49:24 -0700 Subject: [PATCH] copy src website to ~/docs --- docs/CNAME | 1 + docs/README.md | 41 ++++++++++++++++++++++++++ docs/src/about.html | 42 ++++++++++++++++++++++++++ docs/src/assets/css/style.css | 55 +++++++++++++++++++++++++++++++++++ docs/src/assets/js/main.js | 1 + docs/src/index.html | 34 ++++++++++++++++++++++ 6 files changed, 174 insertions(+) create mode 100644 docs/CNAME create mode 100644 docs/README.md create mode 100644 docs/src/about.html create mode 100644 docs/src/assets/css/style.css create mode 100644 docs/src/assets/js/main.js create mode 100644 docs/src/index.html diff --git a/docs/CNAME b/docs/CNAME new file mode 100644 index 0000000..1f2b71b --- /dev/null +++ b/docs/CNAME @@ -0,0 +1 @@ +noaa-gml.github.io/pytorf \ No newline at end of file diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..11caed1 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,41 @@ +# README.md + +# pytorf Website + +This project hosts the documentation and information for the `pytorf` package, which is designed for processing and analyzing observational data. + +## Overview + +The `pytorf` package provides tools for working with various types of observational data, including aircraft, surface, and shipboard measurements. It allows users to efficiently manage and analyze data from different sources, making it easier to derive insights and perform further analysis. + +## Features + +- Supports multiple categories of observational data. +- Provides functions for summarizing and processing data files. +- Easy integration with existing data workflows. + +## Usage + +To use the `pytorf` package, follow these steps: + +1. Install the package using pip: + ``` + pip install pytorf + ``` + +2. Import the package in your Python script: + ```python + import pytorf + ``` + +3. Use the available functions to process your observational data. + +For detailed usage instructions, please refer to the `about.html` page on this website. + +## Contributing + +Contributions to the `pytorf` package are welcome! Please submit issues or pull requests on the GitHub repository. + +## License + +This project is licensed under the MIT License. See the LICENSE file for more details. \ No newline at end of file diff --git a/docs/src/about.html b/docs/src/about.html new file mode 100644 index 0000000..bc2b8aa --- /dev/null +++ b/docs/src/about.html @@ -0,0 +1,42 @@ + + + + + + About PyTorf + + + +
+

About PyTorf

+ +
+
+
+

Overview

+

PyTorf is a Python package designed for processing and analyzing observational data from various sources, including aircraft, surface, and shipboard measurements.

+
+
+

Features

+
    +
  • Supports multiple data categories such as aircraft, surface, and flask measurements.
    • +
  • Provides functions for data summarization and analysis.
    • +
  • Easy integration with other data processing libraries.
    • +
+
+
+

Usage Instructions

+

To use PyTorf, install the package via pip and import it into your Python scripts. Refer to the documentation for detailed usage examples.

+
+
+ + + + \ No newline at end of file diff --git a/docs/src/assets/css/style.css b/docs/src/assets/css/style.css new file mode 100644 index 0000000..9583905 --- /dev/null +++ b/docs/src/assets/css/style.css @@ -0,0 +1,55 @@ +body { + font-family: Arial, sans-serif; + margin: 0; + padding: 0; + background-color: #f4f4f4; +} + +header { + background: #35424a; + color: #ffffff; + padding: 10px 0; + text-align: center; +} + +h1 { + margin: 0; +} + +nav { + margin: 20px 0; +} + +nav a { + color: #ffffff; + text-decoration: none; + padding: 10px 15px; +} + +nav a:hover { + background: #e8491d; +} + +.container { + width: 80%; + margin: auto; + overflow: hidden; +} + +footer { + background: #35424a; + color: #ffffff; + text-align: center; + padding: 10px 0; + position: relative; + bottom: 0; + width: 100%; +} + +section { + padding: 20px; + background: #ffffff; + margin: 20px 0; + border-radius: 5px; + box-shadow: 0 0 10px rgba(0, 0, 0, 0.1); +} \ No newline at end of file diff --git a/docs/src/assets/js/main.js b/docs/src/assets/js/main.js new file mode 100644 index 0000000..559825e --- /dev/null +++ b/docs/src/assets/js/main.js @@ -0,0 +1 @@ +// This file is intentionally left blank. \ No newline at end of file diff --git a/docs/src/index.html b/docs/src/index.html new file mode 100644 index 0000000..e495fee --- /dev/null +++ b/docs/src/index.html @@ -0,0 +1,34 @@ + + + + + + Pytorf Package + + + +
+

Welcome to the Pytorf Package

+ +
+
+
+

Overview

+

The Pytorf package provides tools for working with observational data.

+
+
+

Getting Started

+

To get started with Pytorf, check out the documentation and examples.

+
+
+ + + + \ No newline at end of file