Giter VIP home page Giter VIP logo

quantecon-mini-example's People

Contributors

choldgraf avatar jstac avatar mmcky avatar najuzilu avatar sdstony avatar tomdonoghue avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

quantecon-mini-example's Issues

How to make this example better.

The current plan is for this mini project to be a starting point for users of the CLI, who are encouraged to download, build and view it. The project will feature in the docs as an example that helps people get started quickly.

Discussion is here: executablebooks/meta#46

Here's how they look now.

We already have glue, citations, numbered eqs. What else do we want to add before we go ahead? I would like to see numbered figs with references to them.

What do others want? CC @choldgraf @najuzilu @mmcky

(There are also some small bugs like the TOC appearing twice in the left hand menu and figures not being properly centered.)

Site navigation sidebar style

In a previous version, the title under the sidebar Scientific Python QuickStart had a different font size from its subcategories to indicate the structure of the toctree. If I remember correctly it was the same font size as the header key. This is not the case for our current example:

I also find it strange that index.md shows up on the sidebar. I would expect that if the user wants to go back to the landing page, clicking on the logo should take them there.

@jstac do you have any thoughts on the above?

utf-8 encoding error

As @denigomonov noticed (executablebooks/jupyter-book#907 (comment)) --
jb build mini_book is failing with current master due to a utf-8 encoding error. Last time this happened, the problem originated in jupyter-sphinx and was triggered by an executable cell with a greek letter variable. To reproduce with most recent commits for all executable book packages, I used https://github.com/eoas-ubc/quantecon-mini-example/blob/windows_dev/environment_dev.yml. The error message is:
https://github.com/eoas-ubc/quantecon-mini-example/blob/windows_dev/encoding_error_log.txt (the same error occurs with the qe-mini-example-environment)

missing code-cell outputs

I can't figure out why the the code cells in quantecon-mini-example are missing (see example). They're rendered locally (see screenshot). Since the workflow is not implemented in quantecon-example, I can see the outputs render there just fine (example). This is site-wide.
I wonder if it's a workflow thing. @mmcky: do you think that's possible?

image

Building mini-book

Following the steps from demo book on https://jupyterbook.org/intro.html

When running the following command (in anaconda prompt on Windows 10 PC):

(wintest) C:\Users\luuka\quantecon-mini-example>jupyter-book build ./mini_book

It returns the following output and error:

Running Jupyter-Book v0.8.3
Traceback (most recent call last):
File “c:\users\luuka\anaconda3\envs\wintest\lib\runpy.py”, line 193, in _run_module_as_main
“main”, mod_spec)
File “c:\users\luuka\anaconda3\envs\wintest\lib\runpy.py”, line 85, in run_code
exec(code, run_globals)
File "C:\Users\luuka\Anaconda3\envs\wintest\Scripts\jupyter-book.exe_main.py", line 7, in
File “c:\users\luuka\anaconda3\envs\wintest\lib\site-packages\click\core.py”, line 829, in call
return self.main(*args, **kwargs)
File “c:\users\luuka\anaconda3\envs\wintest\lib\site-packages\click\core.py”, line 782, in main
rv = self.invoke(ctx)
File “c:\users\luuka\anaconda3\envs\wintest\lib\site-packages\click\core.py”, line 1259, in invoke
return process_result(sub_ctx.command.invoke(sub_ctx))
File “c:\users\luuka\anaconda3\envs\wintest\lib\site-packages\click\core.py”, line 1066, in invoke
return ctx.invoke(self.callback, **ctx.params)
File “c:\users\luuka\anaconda3\envs\wintest\lib\site-packages\click\core.py”, line 610, in invoke
return callback(*args, **kwargs)
File "c:\users\luuka\anaconda3\envs\wintest\lib\site-packages\jupyter_book\commands_init.py", line 199, in build
build_modified = max([os.stat(ii).st_mtime for ii in build_files])
ValueError: max() arg is an empty sequence

Does anybody have an idea what I could do to fix this?

Thanks in advance.

  • Python Version: 3.7.9
  • Package versions or output of jupyter-book --version:
    Jupyter Book: 0.8.3
    MyST-NB: 0.10.1
    Sphinx Book Theme: 0.0.39
    MyST-Parser: 0.12.10
    Jupyter-Cache: 0.4.1
    NbClient: 0.5.1
  • Operating System: Windows 10

typos in README.md

I realized the following when I tried to reproduce the example.

line 7: (a is missing in activate)
2. conda activte quantecon-mini-example

line 10:
jb build book/ -----> jb build mini_book/
jb clean book/ -----> jb clean mini_book/
jb clean --all book/ -----> jb clean --all mini_book/

line 14:
mni_ is missing like line 10

Top-right corner page navigation menu not active

In here, the top-right corner On this page navigation menu does not open for md files with subsection heads even if a mouse cursor hovers over it.

I also cloned this repo, successfully reproduced the quantecon-mini-example, and then added a ipynb file with a section head and several subsection heads. But again the On this page menu is not "activated". Are there any option to activate it?

add tableofcontents directive under index

The tableofcontents directive is currently in progress. Once it has been finalized, we should include this directive under index.md.

Information regarding the progress of the directive can be found here.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.