functioneer 0.4.1__tar.gz → 0.4.2__tar.gz

{functioneer-0.4.1/src/functioneer.egg-info → functioneer-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: functioneer
-Version: 0.4.1
+Version: 0.4.2
 Summary: Effortlessly explore function behavior with the ultimate batch runner.
 Author-email: Quinn Marsh <quinnmarsh@hotmail.com>
 Maintainer-email: Quinn Marsh <quinnmarsh@hotmail.com>
@@ -41,7 +41,7 @@ Functioneer is the ultimate batch runner. Prepare to be an analysis ninja, effor
 
 ## Quick Start
 
-**Full set of examples**: [Examples.ipynb (GitHub)](https://github.com/qthedoc/functioneer/blob/main/examples/Examples.ipynb)*\
+**Full set of examples**: [Examples.ipynb (nbviewer.org)](https://nbviewer.org/github/qthedoc/functioneer/blob/main/examples/Examples.ipynb)*\
 *This is currently the main form of documentation.
 
 ### Installation
@@ -67,12 +67,12 @@ def rosenbrock(x, y, a, b):
 Note: forks for `x` and `y` create a 'grid' of values\
 Note: Parameter IDs MUST match your function's args, function evals inside functioneer are fully keyword arg based.
 ```
-anal = fn.AnalysisModule() # Create new analysis
-anal.add.define({'a': 1, 'b': 100}) # define a and b
-anal.add.fork('x', (0, 1, 2)) # Fork analysis, create branches for x=0, x=1, x=2
-anal.add.fork('y', (1, 10))
-anal.add.execute(func=rosenbrock) #
-results = anal.run()
+analysis = fn.AnalysisModule() # Create new analysis
+analysis.add.define({'a': 1, 'b': 100}) # define a and b
+analysis.add.fork('x', (0, 1, 2)) # Fork analysis, create branches for x=0, x=1, x=2
+analysis.add.fork('y', (1, 10))
+analysis.add.execute(func=rosenbrock) #
+results = analysis.run()
 print('Example 1 Output:')
 print(results['df'][['a', 'b', 'x', 'y', 'rosenbrock']])
 ```
@@ -93,11 +93,11 @@ Example 1 Output:
 
 Note: values for `x` and `y` before optimization are used as initial guesses
 ```
-anal = fn.AnalysisModule({'x': 0, 'y': 0})
-anal.add.fork('a', (1, 2))
-anal.add.fork('b', (0, 100, 200))
-anal.add.optimize(func=rosenbrock, opt_param_ids=('x', 'y'))
-results = anal.run()
+analysis = fn.AnalysisModule({'x': 0, 'y': 0})
+analysis.add.fork('a', (1, 2))
+analysis.add.fork('b', (0, 100, 200))
+analysis.add.optimize(func=rosenbrock, opt_param_ids=('x', 'y'))
+results = analysis.run()
 print('\nExample 2 Output:')
 print(results['df'][['a', 'b', 'x', 'y', 'rosenbrock']])
 ```
@@ -113,9 +113,9 @@ Example 2 Output:
 ```
 ## Key Features
 
-- **Test variations of a parameter with a single line of code:** Avoid writing deeply nested loops. Typically varying *n* parameters requires *n* nested loops... not anymore!
+- **Quickly test variations of a parameter with a single line of code:** Avoid writing deeply nested loops. Typically varying *n* parameters requires *n* nested loops... not anymore!
 
-- **Quickly swap out optimization variables:** Most optimization libraries require your function to take in a list or array of values, BUT this makes it very annoying to remap your parameters to and from the array each time you simple want to change an optimization parameter!
+- **Quickly setup optimization:** Most optimization libraries require your function to take in and spit out a list or array, BUT this makes it very annoying to remap your parameters to and from the array each time you simple want to add/rm/swap an optimization parameter!
 
 - **Get results in a consistent easy to use format:** No more questions, the results are presented in a nice clean pandas data frame every time.
 

{functioneer-0.4.1 → functioneer-0.4.2}/README.md

@@ -10,7 +10,7 @@ Functioneer is the ultimate batch runner. Prepare to be an analysis ninja, effor
 
 ## Quick Start
 
-**Full set of examples**: [Examples.ipynb (GitHub)](https://github.com/qthedoc/functioneer/blob/main/examples/Examples.ipynb)*\
+**Full set of examples**: [Examples.ipynb (nbviewer.org)](https://nbviewer.org/github/qthedoc/functioneer/blob/main/examples/Examples.ipynb)*\
 *This is currently the main form of documentation.
 
 ### Installation
@@ -36,12 +36,12 @@ def rosenbrock(x, y, a, b):
 Note: forks for `x` and `y` create a 'grid' of values\
 Note: Parameter IDs MUST match your function's args, function evals inside functioneer are fully keyword arg based.
 ```
-anal = fn.AnalysisModule() # Create new analysis
-anal.add.define({'a': 1, 'b': 100}) # define a and b
-anal.add.fork('x', (0, 1, 2)) # Fork analysis, create branches for x=0, x=1, x=2
-anal.add.fork('y', (1, 10))
-anal.add.execute(func=rosenbrock) #
-results = anal.run()
+analysis = fn.AnalysisModule() # Create new analysis
+analysis.add.define({'a': 1, 'b': 100}) # define a and b
+analysis.add.fork('x', (0, 1, 2)) # Fork analysis, create branches for x=0, x=1, x=2
+analysis.add.fork('y', (1, 10))
+analysis.add.execute(func=rosenbrock) #
+results = analysis.run()
 print('Example 1 Output:')
 print(results['df'][['a', 'b', 'x', 'y', 'rosenbrock']])
 ```
@@ -62,11 +62,11 @@ Example 1 Output:
 
 Note: values for `x` and `y` before optimization are used as initial guesses
 ```
-anal = fn.AnalysisModule({'x': 0, 'y': 0})
-anal.add.fork('a', (1, 2))
-anal.add.fork('b', (0, 100, 200))
-anal.add.optimize(func=rosenbrock, opt_param_ids=('x', 'y'))
-results = anal.run()
+analysis = fn.AnalysisModule({'x': 0, 'y': 0})
+analysis.add.fork('a', (1, 2))
+analysis.add.fork('b', (0, 100, 200))
+analysis.add.optimize(func=rosenbrock, opt_param_ids=('x', 'y'))
+results = analysis.run()
 print('\nExample 2 Output:')
 print(results['df'][['a', 'b', 'x', 'y', 'rosenbrock']])
 ```
@@ -82,9 +82,9 @@ Example 2 Output:
 ```
 ## Key Features
 
-- **Test variations of a parameter with a single line of code:** Avoid writing deeply nested loops. Typically varying *n* parameters requires *n* nested loops... not anymore!
+- **Quickly test variations of a parameter with a single line of code:** Avoid writing deeply nested loops. Typically varying *n* parameters requires *n* nested loops... not anymore!
 
-- **Quickly swap out optimization variables:** Most optimization libraries require your function to take in a list or array of values, BUT this makes it very annoying to remap your parameters to and from the array each time you simple want to change an optimization parameter!
+- **Quickly setup optimization:** Most optimization libraries require your function to take in and spit out a list or array, BUT this makes it very annoying to remap your parameters to and from the array each time you simple want to add/rm/swap an optimization parameter!
 
 - **Get results in a consistent easy to use format:** No more questions, the results are presented in a nice clean pandas data frame every time.
 

{functioneer-0.4.1 → functioneer-0.4.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "functioneer"
-version = "0.4.1"
+version = "0.4.2"
 authors = [{ name = "Quinn Marsh", email = "quinnmarsh@hotmail.com" }]
 maintainers = [{ name = "Quinn Marsh", email = "quinnmarsh@hotmail.com" }]
 description = "Effortlessly explore function behavior with the ultimate batch runner."

{functioneer-0.4.1 → functioneer-0.4.2}/src/functioneer/__init__.py

@@ -1,4 +1,4 @@
 # functioneer/__init__.py
-__version__ = "0.4.1"
+__version__ = "0.4.2"
 from functioneer.analysis import AnalysisModule, AnalysisStep, Define, Fork, Execute, Optimize
 from functioneer.parameter import Parameter

{functioneer-0.4.1 → functioneer-0.4.2/src/functioneer.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: functioneer
-Version: 0.4.1
+Version: 0.4.2
 Summary: Effortlessly explore function behavior with the ultimate batch runner.
 Author-email: Quinn Marsh <quinnmarsh@hotmail.com>
 Maintainer-email: Quinn Marsh <quinnmarsh@hotmail.com>
@@ -41,7 +41,7 @@ Functioneer is the ultimate batch runner. Prepare to be an analysis ninja, effor
 
 ## Quick Start
 
-**Full set of examples**: [Examples.ipynb (GitHub)](https://github.com/qthedoc/functioneer/blob/main/examples/Examples.ipynb)*\
+**Full set of examples**: [Examples.ipynb (nbviewer.org)](https://nbviewer.org/github/qthedoc/functioneer/blob/main/examples/Examples.ipynb)*\
 *This is currently the main form of documentation.
 
 ### Installation
@@ -67,12 +67,12 @@ def rosenbrock(x, y, a, b):
 Note: forks for `x` and `y` create a 'grid' of values\
 Note: Parameter IDs MUST match your function's args, function evals inside functioneer are fully keyword arg based.
 ```
-anal = fn.AnalysisModule() # Create new analysis
-anal.add.define({'a': 1, 'b': 100}) # define a and b
-anal.add.fork('x', (0, 1, 2)) # Fork analysis, create branches for x=0, x=1, x=2
-anal.add.fork('y', (1, 10))
-anal.add.execute(func=rosenbrock) #
-results = anal.run()
+analysis = fn.AnalysisModule() # Create new analysis
+analysis.add.define({'a': 1, 'b': 100}) # define a and b
+analysis.add.fork('x', (0, 1, 2)) # Fork analysis, create branches for x=0, x=1, x=2
+analysis.add.fork('y', (1, 10))
+analysis.add.execute(func=rosenbrock) #
+results = analysis.run()
 print('Example 1 Output:')
 print(results['df'][['a', 'b', 'x', 'y', 'rosenbrock']])
 ```
@@ -93,11 +93,11 @@ Example 1 Output:
 
 Note: values for `x` and `y` before optimization are used as initial guesses
 ```
-anal = fn.AnalysisModule({'x': 0, 'y': 0})
-anal.add.fork('a', (1, 2))
-anal.add.fork('b', (0, 100, 200))
-anal.add.optimize(func=rosenbrock, opt_param_ids=('x', 'y'))
-results = anal.run()
+analysis = fn.AnalysisModule({'x': 0, 'y': 0})
+analysis.add.fork('a', (1, 2))
+analysis.add.fork('b', (0, 100, 200))
+analysis.add.optimize(func=rosenbrock, opt_param_ids=('x', 'y'))
+results = analysis.run()
 print('\nExample 2 Output:')
 print(results['df'][['a', 'b', 'x', 'y', 'rosenbrock']])
 ```
@@ -113,9 +113,9 @@ Example 2 Output:
 ```
 ## Key Features
 
-- **Test variations of a parameter with a single line of code:** Avoid writing deeply nested loops. Typically varying *n* parameters requires *n* nested loops... not anymore!
+- **Quickly test variations of a parameter with a single line of code:** Avoid writing deeply nested loops. Typically varying *n* parameters requires *n* nested loops... not anymore!
 
-- **Quickly swap out optimization variables:** Most optimization libraries require your function to take in a list or array of values, BUT this makes it very annoying to remap your parameters to and from the array each time you simple want to change an optimization parameter!
+- **Quickly setup optimization:** Most optimization libraries require your function to take in and spit out a list or array, BUT this makes it very annoying to remap your parameters to and from the array each time you simple want to add/rm/swap an optimization parameter!
 
 - **Get results in a consistent easy to use format:** No more questions, the results are presented in a nice clean pandas data frame every time.