Skip to content

Commit

Permalink
Updated readme and uploaded example.workload
Browse files Browse the repository at this point in the history
  • Loading branch information
cadebrown committed Sep 21, 2016
1 parent 9c2fbb3 commit ec96dad
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 72 deletions.
32 changes: 14 additions & 18 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,33 +1,29 @@
*.o
*.out
*.pyc
*.credentials
!/program/example.credentials
# Ignore all prefs except the example one
*.prefs
!example.prefs
/node_modules/
/NodePGS/node_modules/
/tmp/
/run.build/
/workloads/*
!/workloads/test.workload

# Output directory
/output/*
!/output/
# All compiled C programs
*.o
*.out

# Prime sieve
*.dat

# Ignore tmp directory for building
/tmp/

# Zipped and compiled versions
/build/

# VScode editor
*.vscode

# JavaPGS netbeans and whatnot
/JPGS/build/
/JPGS/nbproject/
/JPGS/test/
/nbproject/private/
/JPGS/dist/
/JPGS/dist/

# Ignore all npm installed packages
/node_modules/

# VScode editor
*.vscode
96 changes: 43 additions & 53 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,29 @@


██████╗ ██████╗ ███████╗
██╔══██╗██╔════╝ ██╔════╝
██████╔╝██║ ███╗███████╗
██╔═══╝ ██║ ██║╚════██║
██║ ╚██████╔╝███████║
╚═╝ ╚═════╝ ╚══════╝


## Features

### Planned
* GUI Application (Was removed)

### Implemented
* Multithreaded - Specify `in my.prefs`
* Link with DB for users to help search
* OpenCL - Look in folder `JPGS`.

### Removed
* JavaPGS
* GUI Application (Also going to be implemented)
* OpenCL - Too buggy, and multithreaded is better performance


## What is this?
This is a project that searches for functions that are prime for the first few values of input. It is a **P**rime **G**enerator **S**earch. It looks through polynomials, and reports it's findings to the server.

Expand All @@ -21,6 +40,26 @@ To download the project, please check out (http://chemicaldevelopment.us/pgs).
If you would like to help develop the project, you can reach me at [email protected]


## Explanation
For a more in-detail explanation, see our wiki (https://github.com/ChemicalDevelopment/PGS/wiki), but here's a short explanation:


Primes are numbers that can't be made from multiplying two other integers together. The first few primes are 2, 3, 5, 7, 11, 13. A few example functions that return primes for the first few values are:


`2x + 3`
from x = [0 to 2]


`x^2 + x + 41`
from x = [0 to 39]

That last one is prime for 40 consecutive values


This program looks for larger and longer examples of this, and does it over the internet over multiple computers.


## Running
### Releases (Default)
[Sign Up](http://chemicaldevelopment.us/pgs/account) for an account
Expand All @@ -41,8 +80,6 @@ Double click `PGS.exe`

Double click `PGS`



Run a shell in any OS, and run `./PGS` or `./PGS.exe` with some flags found on the (wiki)[https://github.com/ChemicalDevelopment/PGS/wiki].


Expand All @@ -55,52 +92,22 @@ For the default install script, run
./install.sh
```

Then, to run the program:
To run the program:
```
node PGS.js --offline
```

Or, if you would like to run a version that reports the the server,

You need to create an account at (http://chemicaldevelopment.us/pgs/client), and then fill in your email and password (without "{{" or "}}") (git ignores any .prefs files except for example.pref)
You need to create an account at (http://chemicaldevelopment.us/pgs/client)

Then, use your text editor to open `./my.prefs`, and change the email and password
```
{
"RUN_FILE": "./run_c.sh",
"PRIME_FILE": "./primes.dat",
"email": "{{email}}",
"password": "{{password}}",
"workload_preference": "random",
"threads": 2
}
Use your text editor to open `./my.prefs`, and change the email and password

```
Then,
```
node PGS.js
```


## Explanation
For a more in-detail explanation, see our wiki (https://github.com/ChemicalDevelopment/PGS/wiki), but here's a short explanation:


Primes are numbers that can't be made from multiplying two other integers together. The first few primes are 2, 3, 5, 7, 11, 13. A few example functions that return primes for the first few values are:


`2x + 3`
from x = [0 to 2]


`x^2 + x + 41`
from x = [0 to 39]

That last one is prime for 40 consecutive values


This program looks for larger and longer examples of this, and does it over the internet over multiple computers.

## More Info
More info can be found on our wiki (https://github.com/ChemicalDevelopment/PGS/wiki)

Expand All @@ -110,21 +117,4 @@ Website: (http://chemicaldevelopment.us/pgs)

Online Client: (http://chemicaldevelopment.us/pgs/client/)

Account Manager: (http://chemicaldevelopment.us/pgs/client/account/)



## Features

### Planned
* GUI Application (Was removed)

### Implemented
* Multithreaded - Specify `in my.prefs`
* Link with DB for users to help search
* OpenCL - Look in folder `JPGS`.

### Removed
* JavaPGS
* GUI Application (Also going to be implemented)
* OpenCL - Too buggy, and multithreaded is better performance
Account Manager: (http://chemicaldevelopment.us/pgs/client/account/)
3 changes: 2 additions & 1 deletion workloads/.gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Ignore everything in this directory
*
# Except this file
# Except this file and example
!.gitignore
!example.workload

# This way, cloners will have a workloads directory
1 change: 1 addition & 0 deletions workloads/example.workload
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"offsets":[0,0,0],"ranges":[1000,1000,1000]}

0 comments on commit ec96dad

Please sign in to comment.