You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Development.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -60,7 +60,7 @@ mathematician, or the wikipedia article of someone famous.
60
60
61
61
An object's home page should provide a wide variety of information about the
62
62
object. Basic information, of interest to both experts and non-experts,
63
-
should appear ear the top. More specialized information should appear
63
+
should appear near the top. More specialized information should appear
64
64
near the bottom.
65
65
66
66
In the upper right corner of each home page should be the "properties" box,
@@ -209,7 +209,7 @@ Here are some conventions the LMFDB uses:
209
209
210
210
1. If X is the URL of an object, then L/X is the URL of its standard
211
211
L-function. According to the Langlands program, other L-functions
212
-
associated to X may be written on the the form L(s, X, rho). Examples include
212
+
associated to X may be written in the form L(s, X, rho). Examples include
213
213
214
214
- L(s, f, sym^2)
215
215
- L(s, f, spin)
@@ -246,7 +246,7 @@ Here are some conventions the LMFDB uses:
246
246
Qsqrt5 as a search parameter for the coefficient field.
247
247
248
248
Note that number fields like Qsqrt5 has an "official name" as well as a
249
-
nickname. Many discussions have occurred for what appropriate labels for
249
+
nickname. Many discussions have occurred about what appropriate labels for
250
250
objects should be. Examine the structure of existing objects in the
251
251
LMFDB very closely to maintain correct labels and relationships.
252
252
@@ -269,9 +269,9 @@ Here are some conventions the LMFDB uses:
269
269
-`/Motive/Hypergeometric/Q/\<label>`
270
270
-`/NumberField/\<label>`
271
271
272
-
In practice, prior to deciding on a labelling scheme for new objects, one
272
+
In practice, prior to deciding on a labeling scheme for new objects, one
273
273
should talk to the current LMFDB developers (who now have a lot of experience
274
-
in considering labelling schemes).
274
+
in considering labeling schemes).
275
275
276
276
277
277
Templates
@@ -347,7 +347,7 @@ Testing
347
347
```
348
348
It takes a few minutes. If sage or some additional parts are missing it may fail,
349
349
consider updating
350
-
(see [Getting Started](https://github.com/LMFDB/lmfdb/wiki/GettingStarted))
350
+
(see [Getting Started](https://github.com/LMFDB/lmfdb/wiki/GettingStarted))
351
351
352
352
- New blueprints and features should include a `test_<name>.py` file
353
353
which runs tests on all functions.
@@ -382,7 +382,7 @@ field:
382
382
383
383
### Snippet testing
384
384
385
-
Sometimes computer algebra systems make breaking changes which render the code snippets invalid. To catch this, there's a testing system for snippets implemented in `lmfdb/tests/generate_snippet_tests.py`. This runs the code line by line in the various CAS-es, excluding magma. It does not test correctness of the results, only consistency, by comparing with previous results stored in the `lmfdb/tests/snippet_tests` directory. Normally (and at the time of writing), this is run automatically by Github Actions, which generates the relevant log files. However, it is possible to run it manually using the CLI tool
385
+
Sometimes computer algebra systems make breaking changes which render the code snippets invalid. To catch this, there's a testing system for snippets implemented in `lmfdb/tests/generate_snippet_tests.py`. This runs the code line by line in the various CAS-es. It does not test correctness of the results, only consistency, by comparing with previous results stored in the `lmfdb/tests/snippet_tests` directory. Normally (and at the time of writing), this is run automatically by Github Actions, which generates the relevant log files. However, it is possible to run it manually using the CLI tool
@@ -430,15 +430,15 @@ this puts you inside an interactive python debugger, where you can:
430
430
- continue executing code using the `n` command.
431
431
432
432
If you get lost, the command `bt` shows you exactly where you
433
-
are, and `up` helps you to get on step up on the stack.
433
+
are, and `up` helps you to get one step up on the stack.
434
434
Of course, `help <command>` will tell you more.
435
435
436
436
Git Tips
437
437
=========
438
438
439
439
Contributing to the LMFDB requires some familiarity with git, a popular version control system which LMFDB uses. The LMFDB code base is hosted on Github, which is a common hosting service owned by Microsoft.
440
440
- [Official git tutorial](https://git-scm.com/docs/gittutorial) and [Github's git guide](https://github.com/git-guides)
441
-
- Use a global .gitignore file to exclude temporary files like `.DS_store` or `main.py~`; [copy-paste ready instructions on github](https://help.github.com/articles/ignoring-files#global-gitignore).
441
+
- Use a global .gitignore file to exclude temporary files like `.DS_Store` or `main.py~`; [copy-paste ready instructions on github](https://help.github.com/articles/ignoring-files#global-gitignore).
442
442
- Configure your global .gitconfig for shortcuts or global configuration options; for example:
Copy file name to clipboardExpand all lines: GettingStarted.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,7 @@ Installation
46
46
* Install dependencies. This requires you to have write access to the
47
47
Sage installation directory, so should be no problem on a personal
48
48
machine, but if you are using a system-wide Sage install on a shared
49
-
machine, you will need ask a system administrator to do this step.
49
+
machine, you will need to ask a system administrator to do this step.
50
50
51
51
```
52
52
sage -i gap_packages
@@ -76,13 +76,13 @@ Installation
76
76
that). This problem does seem to be resolved for Sage 9.3beta, and it is currently
77
77
unclear if the problem exists for Sage 9.0 or 9.1.
78
78
79
-
- In case the last step fails by is Mac OSX with the error
79
+
- In case the last step fails on Mac OSX with the error
80
80
81
81
```
82
82
Error: pg_config executable not found.
83
83
```
84
84
85
-
we recommend to installing PostgreSQL by doing
85
+
we recommend installing PostgreSQL by doing
86
86
87
87
```
88
88
brew install postgresql
@@ -104,9 +104,9 @@ Installation
104
104
- [optional] Memcache. *This step is not at all necessary and can
105
105
safely be ignored!* Memcache speeds up recompilation of python
106
106
modules during development. Using it requires both installing the
107
-
appropriate package for your Operating System and installing an
107
+
appropriate package for your operating system and installing an
108
108
additional python module. The first line below needs to be run in
109
-
a Sage shell, and the for second you need to be a super-user to
109
+
a Sage shell, and for the second you need to be a super-user to
110
110
install memcached if your machine does not have it.
111
111
112
112
* `easy_install -U python-memcached`
@@ -141,7 +141,7 @@ Running
141
141
* When running with `--debug`, whenever a python (*.py) file changes
142
142
the server will reload automatically. If you save while editing
143
143
at a point where such a file is not syntactically correct, the
144
-
server will crash and you will need to `start_lmfdb` again. Any
144
+
server will crash and you will need to `start-lmfdb` again. Any
145
145
changes to html files will not cause the server to restart, so
146
146
you will need to reload the pages in your browser. Changes in
147
147
the yaml files which are read only once at startup will require
@@ -167,8 +167,8 @@ Running
167
167
CoCalc
168
168
======
169
169
170
-
* You can run the LMFDB inside a [CoCalc](https://www.cocalc.com) project by doing
171
-
following the above installation instructions on a terminal in your project (you may want to
170
+
* You can run the LMFDB inside a [CoCalc](https://www.cocalc.com) project by following
171
+
the above installation instructions on a terminal in your project (you may want to
172
172
install the requirements using the `--user` flag).
173
173
Explicitly,
174
174
@@ -194,7 +194,7 @@ Troubleshooting
194
194
===============
195
195
196
196
[warning] Recently on some linux machines, users have had to install the
197
-
contents of requirements.txt by manually. If the above instructions do not
197
+
contents of requirements.txt manually. If the above instructions do not
198
198
work, un-install the above packages and re-install them one at a time,
199
199
including those in requirements.txt.
200
200
@@ -259,10 +259,10 @@ Code development and sharing your work
259
259
branches upstream to be aware of: `web`, `dev` and `main`:
260
260
261
261
- `web` is changed rarely and contains the code currently running at
262
-
[www.lmfdb.org](www.lmfdb.org)
262
+
[www.lmfdb.org](https://www.lmfdb.org)
263
263
264
264
- `dev` is changed more often and contains the code currently running at
265
-
[beta.lmfdb.org](beta.lmfdb.org)
265
+
[beta.lmfdb.org](https://beta.lmfdb.org)
266
266
267
267
- `main` is the development branch.
268
268
@@ -323,5 +323,5 @@ For anyone who would like to attempt it, the following steps should theoreticall
323
323
* Now you need to run ssh-keygen within the Sage appliance and e-mail the result to Harald Schilly, Jonathan Bober or John Cremona (see above).
324
324
Since copy-and-paste can be tricky from inside the virtual image, we suggest writing to a file shared by the host OS.
325
325
326
-
* The instructions for Linux/OS X should now work. You should be able to forward the mongo database and run `sage -python start-lmfdb.py` within the Sage appliance,
326
+
* The instructions for Linux/OS X should now work. You should be able to run `sage -python start-lmfdb.py` within the Sage appliance,
327
327
and access the resulting website from your host OS' web browser.
0 commit comments