DOCS: complete docstrings and documentation

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Batista Group (Yale University)
+
+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.

README.md

@@ -0,0 +1,63 @@
+# Batista Template
+
+A modern Python project template that provides a solid foundation for building Python packages with best practices and development tools.
+
+## Features
+
+- 🚀 Fast dependency management with `uv`
+- 📚 Documentation with MkDocs and Material theme
+- ✨ Code quality tools (Ruff for linting and formatting)
+- 🔄 GitHub Actions for CI/CD
+- 📦 Modern Python packaging with `pyproject.toml`
+- 🧪 Testing infrastructure
+- 📝 Pre-commit hooks for code quality
+
+## Quick Start
+
+This project uses `uv` for fast and reliable Python package management:
+
+```bash
+# Create and activate a virtual environment
+uv venv
+source .venv/bin/activate
+
+# Install the package and all development dependencies
+uv pip install -e ".[dev]"
+
+# Install pre-commit hooks
+pre-commit install
+```
+
+## Documentation
+
+After installing dependencies, you can run the documentation locally:
+
+```bash
+mkdocs serve
+```
+
+Then open your browser at `http://127.0.0.1:8000`
+
+## Project Structure
+
+```md
+.
+├── data/           # Data files and resources
+├── docs/           # Documentation files (MkDocs)
+├── scripts/        # Utility and automation scripts
+├── src/            # Source code
+│   └── batistatemplate/
+├── tests/          # Test files
+├── .github/        # GitHub Actions workflows
+├── mkdocs.yml      # MkDocs configuration
+├── pyproject.toml  # Project dependencies and settings
+└── .pre-commit-config.yaml  # Pre-commit hooks configuration
+```
+
+## Development
+
+For detailed development instructions, please refer to our [documentation](docs/index.md).
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

data/README.md

@@ -0,0 +1,34 @@
+# Data Directory
+
+This directory is intended for storing data files and resources that are used by the project. This can include:
+
+- Sample data files
+- Configuration files
+- Resource files
+- Test data
+- Data templates
+
+## Structure
+
+```md
+data/
+├── README.md          # This file
+├── sample/            # Sample data files (if any)
+└── config/            # Configuration files (if any)
+```
+
+## Usage
+
+When adding data files to this directory:
+
+1. Ensure the files are in an appropriate format (CSV, JSON, YAML, etc.)
+2. Document any data schema or format requirements
+3. If the data is large, consider adding it to `.gitignore` and providing download instructions
+4. Include sample data for testing and documentation purposes
+
+## Data Guidelines
+
+- Keep sensitive data out of version control
+- Document data sources and any licensing requirements
+- Maintain a clear structure for different types of data
+- Include README files in subdirectories as needed