generated from skills/introduction-to-github
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from Bempong-Sylvester-Obese/viabilitycheckerpr…
…ofile Viabilitycheckerprofile
- Loading branch information
Showing
4 changed files
with
152 additions
and
95 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,36 @@ | ||
| # Compiled source # | ||
| ################### | ||
| *.com | ||
| *.class | ||
| *.dll | ||
| *.exe | ||
| *.o | ||
| *.so | ||
|
|
||
| # Packages # | ||
| ############ | ||
| # it's better to unpack these files and commit the raw source | ||
| # git has its own built in compression methods | ||
| *.7z | ||
| *.dmg | ||
| *.gz | ||
| *.iso | ||
| *.jar | ||
| *.rar | ||
| *.tar | ||
| *.zip | ||
|
|
||
| # Logs and databases # | ||
| ###################### | ||
| # Ignore Python bytecode files | ||
| __pycache__/ | ||
| *.py[cod] | ||
|
|
||
| # Ignore environment files | ||
| venv/ | ||
| env/ | ||
| *.env | ||
|
|
||
| # Ignore log files | ||
| *.log | ||
| *.sql | ||
| *.sqlite | ||
| logs/ | ||
|
|
||
| # Ignore data files | ||
| *.csv | ||
| *.json | ||
| *.xlsx | ||
|
|
||
| # Ignore IDE/editor settings | ||
| .vscode/ | ||
| .idea/ | ||
| *.swp | ||
|
|
||
| # OS generated files # | ||
| ###################### | ||
| # Ignore compiled machine learning models | ||
| models/ | ||
| *.h5 | ||
| *.pkl | ||
|
|
||
| # Ignore dependencies | ||
| *.egg-info/ | ||
| *.dist-info/ | ||
|
|
||
| # Ignore OS-generated files | ||
| .DS_Store | ||
| .DS_Store? | ||
| ._* | ||
| .Spotlight-V100 | ||
| .Trashes | ||
| ehthumbs.db | ||
| Thumbs.db | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,27 @@ | ||
| Copyright (c) GitHub, Inc. | ||
| Obese Land Viability License (Based on MIT License) | ||
|
|
||
| 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: | ||
| Copyright (c) 2025 Bempong Sylvester Obese | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the Obese Land Viability Checker), to deal | ||
| in the Software 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: | ||
|
|
||
| 1. The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
| 2. This software is intended for **agricultural and environmental applications**. Any use | ||
| for unethical, exploitative, or harmful purposes is strictly prohibited. | ||
| 3. Proper attribution to the original author Bempong Sylvester Obese is required in any modified | ||
| or redistributed versions of this 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. | ||
|
|
||
| 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,55 @@ | ||
| Welcome to my First Githyb Project | ||
| ### Obese Farms Viability Checker 🌱 | ||
|
|
||
| 🚜 **A Smart Tool for Evaluating Land Viability** | ||
| Obese Farms Viability Checker is a Python-based tool designed to assess the suitability of land for farming. It leverages data analysis, machine learning, and environmental parameters to provide insights into land productivity. | ||
|
|
||
| --- | ||
|
|
||
| ### 🌟 Features: | ||
| - **Soil Analysis**: Evaluates soil quality based on key agricultural parameters. | ||
| - **Climate Suitability**: Analyzes weather conditions to determine optimal crop growth. | ||
| - **Water Availability**: Assesses proximity to water sources and irrigation feasibility. | ||
| - **Machine Learning Predictions**: Uses AI to predict crop yield based on historical data. | ||
|
|
||
| --- | ||
|
|
||
| ### 🔧 Tech Stack: | ||
| - **Languages**: Python | ||
| - **Libraries**: Pandas, NumPy, Scikit-learn, TensorFlow | ||
| - **Data Sources**: OpenWeather API, Satellite Data | ||
|
|
||
| --- | ||
|
|
||
| ### 🚀 Roadmap: | ||
| - [ ] Implement an interactive UI for ease of use | ||
| - [ ] Expand dataset for higher accuracy | ||
| - [ ] Integrate mobile app support | ||
|
|
||
| --- | ||
|
|
||
| ### 📌 How to Use: | ||
| 1. Clone the repository: | ||
| ```sh | ||
| git clone https://github.com/your-username/obese-viability-checker.git | ||
| ``` | ||
| 2. Install dependencies: | ||
| ```sh | ||
| pip install -r requirements.txt | ||
| ``` | ||
| 3. Run the script: | ||
| ```sh | ||
| python main.py | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ### 🤝 Contributing: | ||
| Contributions are welcome! Feel free to fork this repository and submit a pull request with improvements. | ||
|
|
||
| --- | ||
|
|
||
| ### 📫 Contact: | ||
| For inquiries, reach out via Sylvesterobese6665@gmail.com or open an issue on GitHub. | ||
|
|
||
| 💡 *"Empowering farmers with data-driven insights."* 🚜 | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,73 +1,57 @@ | ||
| <header> | ||
| # Obese Land Viability Checker 🌾 | ||
|
|
||
| <!-- | ||
| <<< Author notes: Course header >>> | ||
| Include a 1280×640 image, course title in sentence case, and a concise description in emphasis. | ||
| In your repository settings: enable template repository, add your 1280×640 social image, auto delete head branches. | ||
| Add your open source license, GitHub uses MIT license. | ||
| --> | ||
| ## 📌 Overview | ||
| The **Obese Land Viability Checker** is an AI-powered tool designed to assess land suitability for agricultural use. By analyzing soil quality, climate conditions, and water availability, it provides valuable insights to help farmers and agribusinesses make informed decisions. | ||
|
|
||
| # Introduction to GitHub | ||
| ## 🚀 Features | ||
| - **Soil Quality Analysis**: Evaluates key soil nutrients and fertility levels. | ||
| - **Climate Suitability**: Assesses temperature, rainfall, and humidity for optimal crop growth. | ||
| - **Water Resource Mapping**: Identifies proximity to irrigation sources and water bodies. | ||
| - **Machine Learning Predictions**: Uses AI to predict crop yields based on historical data. | ||
| - **User-Friendly Interface**: Simple and intuitive for seamless use. | ||
|
|
||
| _Get started using GitHub in less than an hour._ | ||
|
|
||
| </header> | ||
|
|
||
| <!-- | ||
| <<< Author notes: Step 2 >>> | ||
| Start this step by acknowledging the previous step. | ||
| Define terms and link to docs.github.com. | ||
| --> | ||
|
|
||
| ## Step 2: Commit a file | ||
|
|
||
| _You created a branch! :tada:_ | ||
|
|
||
| Creating a branch allows you to edit your project without changing the `main` branch. Now that you have a branch, it’s time to create a file and make your first commit! | ||
|
|
||
| **What is a commit?**: A _[commit](https://docs.github.com/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits)_ is a set of changes to the files and folders in your project. A commit exists in a branch. For more information, see "[About commits](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits)". | ||
|
|
||
| ### :keyboard: Activity: Your first commit | ||
|
|
||
| The following steps will guide you through the process of committing a change on GitHub. A commit records changes in renaming, changing content within, creating a new file, and any other changes made to your project. For this exercise, committing a change requires first adding a new file to your new branch. | ||
|
|
||
| > [!NOTE] | ||
| > `.md` is a file extension that creates a Markdown file. You can learn more about Markdown by visiting "[Basic writing and formatting syntax](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)" in our docs or by taking the "[Communicating using Markdown](https://github.com/skills/communicate-using-markdown)" Skills course. | ||
| 1. On the **< > Code** tab in the header menu of your repository, make sure you're on your new branch `my-first-branch`. | ||
|
|
||
| 2. Select the **Add file** drop-down and click **Create new file**. | ||
|
|
||
|  | ||
| --- | ||
|
|
||
| 3. In the **Name your file...** field, enter `PROFILE.md`. | ||
| ## 🛠️ Technologies Used | ||
| - **Programming Language**: Python 🐍 | ||
| - **Libraries**: Pandas, NumPy, Scikit-learn, TensorFlow | ||
| - **Data Sources**: OpenWeather API, Satellite Imagery, Soil Databases | ||
|
|
||
| 4. In the **Enter file contents here** area, copy the following content to your file: | ||
| --- | ||
|
|
||
| ## 📖 Installation & Usage | ||
| 1. Clone the repository: | ||
| ```sh | ||
| git clone https://github.com/your-username/obese-land-viability-checker.git | ||
| ``` | ||
| Welcome to my GitHub profile! | ||
| 2. Navigate to the project folder: | ||
| ```sh | ||
| cd obese-land-viability-checker | ||
| ``` | ||
| 3. Install dependencies: | ||
| ```sh | ||
| pip install -r requirements.txt | ||
| ``` | ||
| 4. Run the script: | ||
| ```sh | ||
| python main.py | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| 5. Click **Commit changes...** in the upper right corner above the contents box. For commits, you can enter a short commit message that describes what changes you made. This message helps others know what's included in your commit. GitHub offers a simple default message, but let's change it slightly for practice. First, enter `Add PROFILE.md` in the first text-entry field titled "Commit message". | ||
|
|
||
|  | ||
|
|
||
| 6. In this lesson, we'll ignore the other fields and click **Commit changes**. | ||
| 7. Wait about 20 seconds then refresh this page (the one you're following instructions from). [GitHub Actions](https://docs.github.com/en/actions) will automatically update to the next step. | ||
| --- | ||
|
|
||
| <footer> | ||
| ## 🔮 Future Enhancements | ||
| - [ ] Develop a web-based dashboard for visualization. | ||
| - [ ] Mobile app integration for on-the-go analysis. | ||
| - [ ] Expand dataset for increased accuracy. | ||
|
|
||
| <!-- | ||
| <<< Author notes: Footer >>> | ||
| Add a link to get support, GitHub status page, code of conduct, license link. | ||
| --> | ||
| ## 🤝 Contributing | ||
| Contributions are welcome! Feel free to fork the repository and submit a pull request. | ||
|
|
||
| --- | ||
|
|
||
| Get help: [Post in our discussion board](https://github.com/orgs/skills/discussions/categories/introduction-to-github) • [Review the GitHub status page](https://www.githubstatus.com/) | ||
| ## 📫 Contact | ||
| For inquiries, reach out via [Sylvesterobese6665@gmail.com or open an issue on GitHub. | ||
| Mobile: +233(0) 540456262 | ||
|
|
||
| © 2024 GitHub • [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md) • [MIT License](https://gh.io/mit) | ||
| 💡 *"Empowering farmers with AI-driven insights for smarter agriculture."* 🌱 | ||
|
|
||
| </footer> |