Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chrnthnkmutt/jupyter_electriccharge
This project is the collaboration between Charunthon Limseelo and Dr. Stanislas Grare, Department of Physics, King Mongkut’s University of Technology Thonburi
https://github.com/chrnthnkmutt/jupyter_electriccharge
Last synced: 6 days ago
JSON representation
This project is the collaboration between Charunthon Limseelo and Dr. Stanislas Grare, Department of Physics, King Mongkut’s University of Technology Thonburi
- Host: GitHub
- URL: https://github.com/chrnthnkmutt/jupyter_electriccharge
- Owner: chrnthnkmutt
- License: mit
- Created: 2023-12-16T06:11:08.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-01-05T00:45:34.000Z (11 months ago)
- Last Synced: 2024-01-05T01:37:29.711Z (11 months ago)
- Language: Jupyter Notebook
- Size: 1.11 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Electric Charge Visualization on Jupyter Notebook
##### Table of Contents
- [ Overview](#-overview)
- [ Repository Structure](#-repository-structure)
- [ Getting Started](#-getting-started)
- [ Prerequisites](#-prerequisites)
- [ Installation](#-installation)
- [ Usage](#-usage)
- [ Tests](#-tests)
- [ Contributing](#-contributing)
---
## Overview
In this collaboration, I do need to study about Electric Field, Electric Charge, and Electric Magnetism as the prerequisite of the visualized experiment with Professor Dr. Stanislas Pierre Maximilien Grare in PHY104 (Electrical Physics Course). In meantime, we both do study on the working process of using libraries for plotting the field and dipole in Jupyter Notebook, which actually using Sci-py and Matplotlib for making the visualization of the electric field and electric charge direction.
For somebody who would like to work for the visualization like above, both Google Collaborations and Visual Studio Code would be the best selection for who would like to work on. But Google Collaborations might have a better compilation than VS Code since it’s installed a lot of environment within this online IDE.
---
## Repository Structure
```sh
└── Jupyter_ElectricCharge/
├── LICENSE
├── README.md
├── blogbanner.png
├── elecpotential.ipynb
└── electrostaticdipole.ipynb
```
---
## Getting Started
### Prerequisites
**JupyterNotebook**: `version x.y.z`
### Installation
Build the project from source:
1. Clone the Jupyter_ElectricCharge repository:
```sh
❯ git clone https://github.com/chrnthnkmutt/Jupyter_ElectricCharge
```
2. Navigate to the project directory:
```sh
❯ cd Jupyter_ElectricCharge
```
### Usage
To run the project, execute the following command:
```sh
❯ jupyter nbconvert --execute notebook.ipynb
```
### Tests
Execute the test suite using the following command:
```sh
❯ pytest notebook_test.py
```
---
## Contributing
Contributions are welcome! Here are several ways you can contribute:
- **[Report Issues](https://github.com/chrnthnkmutt/Jupyter_ElectricCharge/issues)**: Submit bugs found or log feature requests for the `Jupyter_ElectricCharge` project.
- **[Submit Pull Requests](https://github.com/chrnthnkmutt/Jupyter_ElectricCharge/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs.
- **[Join the Discussions](https://github.com/chrnthnkmutt/Jupyter_ElectricCharge/discussions)**: Share your insights, provide feedback, or ask questions.
Contributing Guidelines
1. **Fork the Repository**: Start by forking the project repository to your github account.
2. **Clone Locally**: Clone the forked repository to your local machine using a git client.
```sh
git clone https://github.com/chrnthnkmutt/Jupyter_ElectricCharge
```
3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name.
```sh
git checkout -b new-feature-x
```
4. **Make Your Changes**: Develop and test your changes locally.
5. **Commit Your Changes**: Commit with a clear message describing your updates.
```sh
git commit -m 'Implemented new feature x.'
```
6. **Push to github**: Push the changes to your forked repository.
```sh
git push origin new-feature-x
```
7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. **Review**: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
Contributor Graph
