From 064ba4afbd91ecaee14860c050aef4921cd0da96 Mon Sep 17 00:00:00 2001 From: Ashley Bao Date: Fri, 20 Jan 2023 15:34:18 -0500 Subject: [PATCH] a guide to propeller update --- docs/A_Guide_To_Propeller.html | 14 +++++--------- src/docs_src/A_Guide_To_Propeller.md | 16 +++++----------- 2 files changed, 10 insertions(+), 20 deletions(-) diff --git a/docs/A_Guide_To_Propeller.html b/docs/A_Guide_To_Propeller.html index 9e584de..91402e7 100644 --- a/docs/A_Guide_To_Propeller.html +++ b/docs/A_Guide_To_Propeller.html @@ -24,7 +24,6 @@
  • Contributing
  • License
  • Citation
    • -
  • About Propeller
  • Contact
    • @@ -32,7 +31,7 @@

    You can evolve a Push program to solve a problem. You can also use the Push interpreter to evaluate Push programs in other projects, for example in agent-based evolutionary simulations in which agents are controlled by evolving Push programs.

    Installation

    If you have installed leiningen, which is a tool for running Clojure programs, then you can run Propeller on a genetic programming problem that is defined within this project from the command line with the command lein run -m <namespace>, replacing <namespace> with the actual namespace that you will find at the top of the problem file.

    -

    If you have installed Clojure, you can run Propeller on a genetic programming problem with the command clj -m <namespace>, replacing <namespace> with the actual namespace that you will find at the top of the problem file. The examples below use leiningen, but you can replace lein run -m with clj --main to run the same problem.

    +

    If you have installed Clojure, you can run Propeller on a genetic programming problem with the command clj --main <namespace>, replacing <namespace> with the actual namespace that you will find at the top of the problem file. The examples below use leiningen, but you can replace lein run -m with clj --main to run the same problem.

    A specific example is provided later below.

    How do I run Propeller on a problem?

    To run a problem in Propeller, you want to call the -main function in the problem file using leiningen. The -main function will create a map of arguments from the input and run the main genetic programming loop.

    @@ -64,7 +63,7 @@

    When you run a problem, you will get a report each generation with the following information:

    -
    :generation            
+
     :generation            
  :best-plushy 
  :best-program          
  :best-total-error      
@@ -114,10 +113,9 @@
 
    If you want to run the problem with the default parameters, then you should call -main without arguments, as `(-main).
    
 
    Tutorials
    
 
 
    Contributing
    
 
    You can report a bug on the GitHub issues page.
    
@@ -127,8 +125,6 @@
 
    This commercially-friendly copyleft license provides the ability to commercially license binaries; a modern royalty-free patent license grant; and the ability for linked works to use other licenses, including commercial ones.
    
 
    Citation
    
 
    We are in the process of creating a DOI, but in the meantime, we ask that you cite the link to the repository if you use Propeller.
    
-
    About Propeller
    
-
    Propeller was created by
    
 
    Contact
    
 
    To discuss Propeller, Push, and PushGP, you can join the Push-Language Discourse.
    
 
\ No newline at end of file
diff --git a/src/docs_src/A_Guide_To_Propeller.md b/src/docs_src/A_Guide_To_Propeller.md
index 778aba4..3a67d2e 100644
--- a/src/docs_src/A_Guide_To_Propeller.md
+++ b/src/docs_src/A_Guide_To_Propeller.md
@@ -20,7 +20,6 @@ For more information on Push and PushGP see http://pushlanguage.org.
   * [Contributing](#contributing)
   * [License](#license)
   * [Citation](#citation)
-  * [About Propeller](#about-propeller)
   * [Contact](#contact)
 
 
@@ -40,7 +39,7 @@ line with the command `lein run -m `, replacing ``
 with the actual namespace that you will find at the top of the problem file.
 
 If you have installed [Clojure](https://clojure.org/guides/install_clojure#java), you can run Propeller on a genetic programming 
-problem with the command `clj -m `, replacing `` with 
+problem with the command `clj --main `, replacing `` with 
 the actual namespace that you will find at the top of the problem file. 
 The examples below use leiningen, but you can replace `lein run -m` with `clj --main` to run the same problem.
 
@@ -86,7 +85,7 @@ The possible keys come from the table below:
 When you run a problem, you will get a report each generation with the following information:
 
 ```
-:generation            
+ :generation            
  :best-plushy 
  :best-program          
  :best-total-error      
@@ -172,10 +171,9 @@ then you should call `-main` without arguments, as `(-main).
 
 ## Tutorials
 
-- Adding genetic operators
-- Adding selection methods
-- Adding a new problem
-- Using Propeller for Experiments
+- [Adding genetic operators](Adding_Genetic_Operators.md)
+- [Adding selection methods](Adding_Selection_Method.md)
+- [Adding a new problem](Adding_Problem.md)
 
 ## Contributing
 
@@ -195,10 +193,6 @@ a modern royalty-free patent license grant; and the ability for linked works to
 We are in the process of creating a DOI, but in the meantime, 
 we ask that you cite the [link to the repository](https://github.com/lspector/propeller) if you use Propeller.
 
-## About Propeller
-
-Propeller was created by
-
 ## Contact
 
 To discuss Propeller, Push, and PushGP, you can join the [Push-Language Discourse](https://discourse.pushlanguage.org/).
\ No newline at end of file