copy src website to ~/docs

noaa-gml · Feb 20, 2025 · e9f5dc1 · e9f5dc1
1 parent 583417c
commit e9f5dc1
Show file tree

Hide file tree

Showing 6 changed files with 174 additions and 0 deletions.
diff --git a/docs/CNAME b/docs/CNAME
@@ -0,0 +1 @@
+noaa-gml.github.io/pytorf
diff --git a/docs/README.md 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.
diff --git a/docs/src/about.html b/docs/src/about.html
@@ -0,0 +1,42 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>About PyTorf</title>
+    <link rel="stylesheet" href="assets/css/style.css">
+</head>
+<body>
+    <header>
+        <h1>About PyTorf</h1>
+        <nav>
+            <ul>
+                <li><a href="index.html">Home</a></li>
+                <li><a href="about.html">About</a></li>
+            </ul>
+        </nav>
+    </header>
+    <main>
+        <section>
+            <h2>Overview</h2>
+            <p>PyTorf is a Python package designed for processing and analyzing observational data from various sources, including aircraft, surface, and shipboard measurements.</p>
+        </section>
+        <section>
+            <h2>Features</h2>
+            <ul>
+                <li>Supports multiple data categories such as aircraft, surface, and flask measurements.</li>
+                <li>Provides functions for data summarization and analysis.</li>
+                <li>Easy integration with other data processing libraries.</li>
+            </ul>
+        </section>
+        <section>
+            <h2>Usage Instructions</h2>
+            <p>To use PyTorf, install the package via pip and import it into your Python scripts. Refer to the documentation for detailed usage examples.</p>
+        </section>
+    </main>
+    <footer>
+        <p>&copy; 2023 PyTorf. All rights reserved.</p>
+    </footer>
+    <script src="assets/js/main.js"></script>
+</body>
+</html>
diff --git a/docs/src/assets/css/style.css 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);
+}
diff --git a/docs/src/assets/js/main.js b/docs/src/assets/js/main.js
@@ -0,0 +1 @@
+// This file is intentionally left blank.
diff --git a/docs/src/index.html b/docs/src/index.html
@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Pytorf Package</title>
+    <link rel="stylesheet" href="assets/css/style.css">
+</head>
+<body>
+    <header>
+        <h1>Welcome to the Pytorf Package</h1>
+        <nav>
+            <ul>
+                <li><a href="index.html">Home</a></li>
+                <li><a href="about.html">About</a></li>
+            </ul>
+        </nav>
+    </header>
+    <main>
+        <section>
+            <h2>Overview</h2>
+            <p>The Pytorf package provides tools for working with observational data.</p>
+        </section>
+        <section>
+            <h2>Getting Started</h2>
+            <p>To get started with Pytorf, check out the documentation and examples.</p>
+        </section>
+    </main>
+    <footer>
+        <p>&copy; 2023 Pytorf Project. All rights reserved.</p>
+    </footer>
+    <script src="assets/js/main.js"></script>
+</body>
+</html>