From 74ca756b3caf3a299548821d97bb8effdc464de4 Mon Sep 17 00:00:00 2001 From: Matheus Cordeiro Date: Tue, 22 Oct 2024 11:11:24 -0300 Subject: [PATCH] v1.5.0 --- README.md | 24 +++++++++++++++++------- setup.cfg | 2 +- setup.py | 2 +- 3 files changed, 19 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index b6b406e..3f1a6a7 100644 --- a/README.md +++ b/README.md @@ -15,12 +15,22 @@ This package represents the time-independent wavefunctions of the Quantum Harmon ## 📑 Table of Contents -- [Advantages](#-advantages) -- [Setup](#-setup) -- [Examples](#-exemples) -- [Theory](#-theory) -- [References](#-theory) -- [Contact](#-contact) +- [📑 Table of Contents](#-table-of-contents) +- [✨ Advantages](#-advantages) +- [🛠️ Setup](#️-setup) +- [🎨 Examples](#-examples) +- [🌊 The Wavefunction](#-the-wavefunction) + - [Schrödinger Equation](#schrödinger-equation) + - [Normalization](#normalization) + - [Quantum Harmonic Oscillator](#quantum-harmonic-oscillator) +- [🔁 The Wavefunction Recurrence](#-the-wavefunction-recurrence) +- [⚡️The Numba Module - Hybrid Solution](#️the-numba-module---hybrid-solution) +- [⚡️ The Numba Module - Arguments](#️-the-numba-module---arguments) +- [⚙️ The Cython Module](#️-the-cython-module) +- [📖 References](#-references) +- [🤝 Contributing](#-contributing) +- [📜 License](#-license) +- [📬 Contact](#-contact) ## ✨ Advantages @@ -30,7 +40,7 @@ This package represents the time-independent wavefunctions of the Quantum Harmon - **Past response cache**: This package provides a caching module designed to enhance the performance of functions that take multiple positions of a *NumPy* array as input. By leveraging Python's functools.lru_cache, this module stores previously computed results, eliminating the need for redundant calculations. This caching module is inspired by the [caching module](https://github.com/XanaduAI/MrMustard/blob/develop/mrmustard/math/caching.py#L26) from Mr. Mustard, a package from the photonic quantum computing company Xanadu. -## 🛠 Setup +## 🛠️ Setup To use this package, simply run the following command in the command line: ```bash pip install fast-wave diff --git a/setup.cfg b/setup.cfg index 6d18caf..209c18c 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = fast_wave -version = 1.4.19 +version = 1.5.0 description = Package for the calculation of the time-independent wavefunction. author = Matheus Gomes Cordeiro author_email = matheusgomescord@gmail.com diff --git a/setup.py b/setup.py index 541a532..078923c 100644 --- a/setup.py +++ b/setup.py @@ -6,7 +6,7 @@ long_description = fh.read() name = "fast_wave" -version = "1.4.19" +version = "1.5.0" description = "Package for the calculation of the time-independent wavefunction." author_email = "matheusgomescord@gmail.com" url = "https://github.com/pikachu123deimos/fast-wave"