Commit 24887342 authored by Jacob August Davison's avatar Jacob August Davison
Browse files

small update

parent 092e815c
......@@ -11,6 +11,13 @@ For practical use, include these lines at the top of your Python code:
`sys.path.append('path/to/im-srg_tensorflow/')`
`from main import main`
#### RUN AN IM-SRG(2) FLOW:
The main() method implements the IM-SRG(2). To compute an IM-SRG(2) flow on the Pairing model with half-filling, with g=0.5, pb=0.0, 8 single particle states, standard reference state [1,1,1,1,0,0,0,0], and Wegner generator,
you only have to include this line:
`main(4,4)`
Consult the documentation for information on the keyword parameters provided by main().
#### FILES:
* `testing_tensorflow_v2.ipynb`: main notebook for TensorFlow implementation
......@@ -25,6 +32,12 @@ For practical use, include these lines at the top of your Python code:
* `TODO.md`: information regarding future tasks or strategies to implement
* `README.md`: overview of project (this file)
#### SUMMARY OF `oop_imsrg/`:
This directory contains all files for solving the IM-SRG using an object-oriented approach. The purpose of writing an object-oriented code is so that updates can be designed and implemented without major changes to the base IM-SRG(2) code that already works. The OOP code is "plug-and-play" in the sense that any class that inherits from Hamiltonian, Generator, and Flow can be used to run the code. In this way, algorithms that solve the IM-SRG flow in different ways (e.g. three-body truncation, different generator, etc.) can be encapsulated in their own classes without changes to the main method.
Documentation about each class and how they are used is found in `oop_imsrg/docs`.
#### SUMMARY OF `testing_tensorflow_v2.ipynb`:
__Cell 1:__
......@@ -107,9 +120,3 @@ Performance testing. Measures the time for one iteration of the flow.
__Cell 14:__
Performance testing. Measures the time for flow convergence with _g=0.5_ and _pb=0.0_.
#### SUMMARY OF `oop_imsrg/`:
This directory contains all files for solving the IM-SRG using an object-oriented approach. The purpose of writing an object-oriented code is so that updates can be designed and implemented without major changes to the base IM-SRG(2) code that already works. The OOP code is "plug-and-play" in the sense that any class that inherits from Hamiltonian, Generator, and Flow can be used to run the code. In this way, algorithms that solve the IM-SRG flow in different ways (e.g. three-body truncation, different generator, etc.) can be encapsulated in their own classes without changes to the main method.
Documentation about each class and how they are used is found in `oop_imsrg/docs`.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment