Packaged code for PyPI by guanpu

.gitattributes

@@ -0,0 +1 @@
+guanpu_diffusion2d/_version.py export-subst

.pypirc

@@ -0,0 +1,9 @@
+[distutils]
+index-servers =
+    pypi
+    testpypi
+
+[testpypi]
+repository = https://test.pypi.org/legacy/
+username = guanpu
+password = pypi-AgENdGVzdC5weXBpLm9yZwIkYmQzNTBlZTMtNjgxYy00ZmJkLWIyM2UtMGUyMDI4YTNkMTRjAAIqWzMsIjIyZDk3MDFjLWU3MmItNDcxZi05NzQxLWU0MDczYjU4OWMzMyJdAAAGIKXDLONotzVjaQFRGcDfABxQvzSkZ1M9qNQXtBOWahc-

README.md

@@ -1,19 +1,58 @@
 # diffusion2D
 
-## Instructions for students
+## Instructions for Students
 
 Please follow the instructions in [pypi_exercise.md](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/pypi_exercise.md).
 
 The code used in this exercise is based on [Chapter 7 of the book "Learning Scientific Programming with Python"](https://scipython.com/book/chapter-7-matplotlib/examples/the-two-dimensional-diffusion-equation/).
 
-## Project description
+---
 
-## Installing the package
+## Project Description
 
-### Using pip3 to install from PyPI
+The `diffusion2D` project simulates the 2D heat diffusion equation using a finite difference method. It demonstrates how heat diffuses over a square plate with customizable parameters, such as thermal diffusivity, grid resolution, and initial temperature distribution.
 
-### Required dependencies
+The project is modular, with clear separation of the solver and plotting functions. It serves as an exercise for learning Python packaging and distribution techniques.
 
-## Running this package
+---
+
+## Installing the Package
+
+### Using pip3 to Install from PyPI
+
+Once the package is published to PyPI, you can install it with:
+
+```bash
+pip install -i https://test.pypi.org/simple/ guanpu-diffusion2d
+```
+
+### Required Dependencies
+
+The following dependencies are required to use this package:
+
+- **Python** >= 3.6
+- **NumPy**
+- **Matplotlib**
+
+These dependencies will be installed automatically if you use `pip` to install the package.
+
+---
+
+## Running this Package
+
+After installing the package, you can run the 2D diffusion simulation directly by importing and calling the `solve()` function:
+
+```python
+from guanpu_diffusion2d import diffusion2d
+
+# Run the simulation with default parameters
+diffusion2d.solve()
+
+# Customize parameters (e.g., grid size, thermal diffusivity)
+diffusion2d.solve(dx=0.05, dy=0.05, D=2.0)
+```
+
+---
 
 ## Citing
+just cite plz

guanpu_diffusion2d/__init__.py

@@ -0,0 +1,6 @@
+from ._version import get_versions
+__version__ = get_versions()["version"]
+del get_versions
+
+from . import _version
+__version__ = _version.get_versions()['version']