Opened 9 years ago

Closed 6 years ago

#13342 closed enhancement (fixed)

Adds Abelian sandpile model to the reference manual

Reported by: dcoudert Owned by: mvngu
Priority: major Milestone: sage-duplicate/invalid/wontfix
Component: documentation Keywords: sandpile
Cc: dperkinson Merged in:
Authors: David Coudert Reviewers:
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description (last modified by dcoudert)

There is a nice thematic tutorial on Sandpiles (http://www.sagemath.org/doc/thematic_tutorials/sandpile.html), but the functions are not included in the reference manual. This is the goal of this patch.

Attachments (1)

trac_13342-adds-sandpile-to-reference-manual.patch (3.6 KB) - added by dcoudert 9 years ago.
Without touching file setup.py

Download all attachments as: .zip

Change History (13)

comment:1 follow-up: Changed 9 years ago by dcoudert

  • Cc dperkinson added
  • Description modified (diff)
  • Status changed from new to needs_review

I'm unable to build the documentation :( Any help to find the missing instructions is more than welcome.

comment:2 Changed 9 years ago by dperkinson

I was unable to apply the patch. Running hg_sage.apply('trac_13342-adds-sandpile-to-reference-manual.patch') produced an error:

sage: hg_sage.apply('/home/davidp/downloads/trac_13342-adds-sandpile-to-reference-manual.patch') cd "/usr/local/sage/devel/sage" && sage --hg import "/home/davidp/downloads/trac_13342-adds-sandpile-to-reference-manual.patch" applying /home/davidp/downloads/trac_13342-adds-sandpile-to-reference-manual.patch unknown exception encountered, please report by visiting http://mercurial.selenic.com/wiki/BugTracker Python 2.7.3 (default, Jul 9 2012, 15:05:17) [GCC 4.6.3] Mercurial Distributed SCM (version 1.8.4) Extensions loaded: color, mq, pager, rebase, relink Traceback (most recent call last):

File "/usr/local/sage/local/bin/hg", line 38, in <module>

mercurial.dispatch.run()

<------- snip ------------->

File "/usr/local/sage/local/lib/python/mercurial/patch.py", line 983, in scangitpatch

gitpatches = readgitpatch(gitlr)

File "/usr/local/sage/local/lib/python/mercurial/patch.py", line 339, in readgitpatch

gp.setmode(int(line[-6:], 8))

ValueError?: invalid literal for int() with base 8: '</pre>'

I don't know if this is a problem with sage or a problem with the patch.

comment:3 in reply to: ↑ 1 Changed 9 years ago by dperkinson

Replying to dcoudert:

I'm unable to build the documentation :( Any help to find the missing instructions is more than welcome.

Do you mean that

sage -docbuild reference html

does not work? I read about making the document in the installation guide. You can also enter

sage -docbuild -H

to see all the options.

comment:4 Changed 9 years ago by dcoudert

I don't use the hg_sage.apply('...') function to apply a patch but

sage -hg qimport some_patch.patch
sage -hg qpush
sage -b
...

Currently the patch has no effect when running:

sage -docbuild reference html

The objective is to build a reference page for sandpiles, as for all other modules in sage.

Most probably, I'm missing some informations in some .rst or .py file, but I don't know which one :(

Let's hope someone will be able to find the solution.

comment:5 Changed 9 years ago by jdemeyer

  • Status changed from needs_review to needs_work

Why are you changing setup.py?

comment:6 Changed 9 years ago by dcoudert

When I was trying to build this documentation, I did some cleaning to setup.py, but you are right this should not be in this patch. I will remove it.

I still don't know what's missing for building the documentation.

When I run trying to build the documentation, I got the following message. It builds a page sandpiles.html, but it is empty :(

ompote:/path-to-sage/sage-5.3.beta0/devel/sage> ../../sage -docbuild reference html                                                        
sphinx-build -b html -d /path-to-sage/sage-5.3.beta0/devel/sage/doc/output/doctrees/en/reference    /path-to-sage/sage-5.3.beta0/devel/sage/doc/en/reference /path-to-sage/sage-5.3.beta0/devel/sage/doc/output/html/en/reference
Running Sphinx v1.1.2
loading pickled environment... done
loading intersphinx inventory from /path-to-sage/sage-5.3.beta0/devel/sage/doc/common/python.inv...
building [html]: targets for 2 source files that are out of date
updating environment: 0 added, 2 changed, 0 removed
reading sources... [ 50%] index
reading sources... [100%] sandpiles

/path-to-sage/sage-5.3.beta0/devel/sage/doc/en/reference/sandpiles.rst:4: WARNING: toctree contains reference to nonexisting document u'sage/sandpiles/sandpile'
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 50%] index
writing output... [100%] sandpiles

writing additional files... genindex py-modindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 1 warning.
Build finished.  The built documents can be found in /path-to-sage/sage-5.3.beta0/devel/sage/doc/output/html/en/reference

Changed 9 years ago by dcoudert

Without touching file setup.py

comment:7 Changed 8 years ago by jdemeyer

  • Milestone changed from sage-5.11 to sage-5.12

comment:8 Changed 8 years ago by vbraun_spam

  • Milestone changed from sage-6.1 to sage-6.2

comment:9 Changed 8 years ago by vbraun_spam

  • Milestone changed from sage-6.2 to sage-6.3

comment:10 Changed 7 years ago by vbraun_spam

  • Milestone changed from sage-6.3 to sage-6.4

comment:11 Changed 6 years ago by chapoton

  • Milestone changed from sage-6.4 to sage-duplicate/invalid/wontfix
  • Status changed from needs_work to positive_review

comment:12 Changed 6 years ago by vbraun

  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.