Git Product home page Git Product logo

design's Introduction

Jupyter

Read this in other languages: English, Español, Português, Français

Jupyter metapackage for installation and documents

Documentation structure

This documentation uses the Sphinx documentation engine.

The documentation is located in the docs/source folder. When you build the documentation, it will be placed in the docs/build folder. It is written in a combination of reStructuredText and MyST Markdown.

Build the documentation locally

There are a few ways to build the documentation; see below for instructions:

Build the documentation automatically with nox

The easiest way to build the documentation locally is by using the nox command line tool. This tool makes it easy to automate commands in a repository, and we have included a docs command to quickly install the dependencies and build the documentation.

To build and preview the site locally, follow these steps:

  1. Clone this repository.

    $ git clone https://github.com/jupyter/jupyter
    $ cd jupyter
  2. Install nox

    $ pip install nox
  3. Run the docs command

    $ nox -s docs

This will install the needed dependencies in a virtual environment using pip. It will then place the documentation in the docs/build/html folder. You may explore these HTML files in order to preview the site.

Create a live server to automatically preview changes

There is another nox command that will do the above, and also create a live server that watches your source files for changes, and auto-builds the website any time a change is made.

To start this live server, use the following nox command:

$ nox -s docs-live

When the build is finished, go to the URL that is displayed. It should show a live preview of your documentation.

To stop serving the website, press Ctrl-C in your terminal

Build the documentation manually

To build the documentation manually, follow these steps:

First, install the miniconda Python distribution.

Next, navigate to the /docs directory and create a conda environment:

conda env create -f environment.yml

Activate the environment:

source activate jupyter_docs

Build the docs using Sphinx with the following commands:

make clean
make html

The docs will be built in build/html. They can be viewed by opening build/html/index.html or starting an HTTP server and navigating to 0.0.0.0:8000 in your web browser.

python3 -m http.server

Releasing the jupyter metapackage

Anyone with push access to this repo can make a release of the Jupyter metapackage (this happens very rarely). We use tbump to publish releases.

tbump updates version numbers and publishes the git tag of the version. Our GitHub Actions then build the releases and publish them to PyPI.

The steps involved:

  1. Install tbump: pip install tbump
  2. Tag and publish the release tbump $NEW_VERSION.

That's it!

design's People

Contributors

aluu317 avatar awantulok avatar blink1073 avatar cameronoelsen avatar carreau avatar choldgraf avatar consideratio avatar ellisonbg avatar faricacarroll avatar i-am-am avatar minrk avatar parente avatar peller avatar rgbkrk avatar spoorthyv avatar takluyver avatar tgeorgeux avatar zsailer 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  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  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

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

design's Issues

Moving old designs

@ellisonbg @tgeorgeux Some of the things in here seem outdated/no longer in use. Can we make it clear what's old and what's current by having an archive folder? For example, the Galileo folder looks like it's older branding.

Do we have Jupyter stickers?

As SciPy / PEARC / JupyterCon are coming up, I wonder if anybody has a stash of stickers sitting around. Anybody know of some?

Updated Twitter

I've been working on updating our twitter page. Specifically the profile picture and banner image. Let me know if you have any issues and opinions.

@Ruv7

Profile Picture:
frame 1

Banner Image:
artboard 11

Preview:
screen shot 2016-09-16 at 2 35 56 pm

Current Twitter:
screen shot 2016-10-14 at 3 46 55 pm

JupyterDay logos

So I made a few different designs for the JupyterDay logo and narrowed it down to these two. I really like the first logo more-so than the second because of the reference to a pin (location). The second logo was more focused on the content of the event. I would love feedback on which is your favorite!

jupyterday
jupyterday2

Print color decision

I am currently working to standardize how Jupyter's colors look when printed, starting with Jupyter orange. To do this, I have been measuring CIE-Lab values of previously printed materials, looking at how CMYK values can be calculated from the existing RGB (243,118,38) and hex code (#F37626) values, and purchasing Pantone's Color Bridge reference books to ensure accuracy.

Mathematically, C0 M53 Y85 K3 seems like the best conversion, but @ellisonbg and I have been leaning away from this because it seems a bit light and dull. Adobe products convert Jupyter orange to C0 M67 Y97 K0. The closest Pantone color, 158C, converts to C0 M62 Y95 K0. The Adobe and Pantone colors are very close to each other, and the final decision will probably be in that ballpark. We are waiting to make a final decision until we have the Color Bridge book, and can do some more comparisons on different types of printers.

Create brand guide

This is an issue to track ongoing work by the designers at Cal Poly to create a visual brand guide that documents the visual design and usage aspects of our logo in software, print media, websites, etc. I will let the teams add information about what they are doing.

@jupyter/designers

Syntax Highlighting for Jupyter

Hi all,

I'm aware you are working in a new theme as of #10 and I think it looks great, but you are not (at least from what I read) giving the user the possibility of choosing a specific syntax highlighting. Most IDE let the user choose from a variety of them.

I think both things should be separated, as some user might not want to change the appearance of the notebook but only the highlighting.

As in my university, teachers wanted to have a different syntax highlighting for the code so it could be easily disguised from text for those who are learning to code with Jupyter. I already created a plugin to do this, but it would be great to be integrated in the default package.

What do you think about this ?

Define community guidelines for extending Jupyter design assets

The issue from @jasongrout here: https://github.com/jupyter/trademark/issues/7 got me thinking that this is quite a common pattern that I've seen. It goes something like:

  • Jupyter is inherently modular and extendible
  • So people extend it to new kernels/use-cases/etc
  • They want a logo for their project
  • So they slightly modify the Jupyter logo to adapt it to their project-specific setup

In this case it was combining the Rust logo w/ the Jupyter logo, but I've seen it with domain-specific things, color changes, etc.

Since Jupyter is itself designed to be extensible, I think it would be valuable to the community if there were guidelines for how people could gracefully (and without violating Jupyter's trademarks) build on top of Jupyter design assets for their own logos and such. For example - what if somebody designs a new language-specific kernel and they'd like to make a logo for it. It would be nice if there a repeatable pattern they could follow to generate this logo (e.g. the Jupyter logo + a designated space where a new logo would go).

This is beyond my personal design skills, but I wanted to flag it as a thing to think about. How could Jupyter take its philosophy towards infrastructure, and also apply it to design?

JupyterHub Sign In Page

Beginning inspiration and mock-ups for JupyterHub sign in page:
(Screenshots)
screen-shot-2014-09-15-at-4 08 31-pm
screen-shot-2014-09-15-at-4 08 43-pm
screen-shot-2014-09-15-at-4 09 12-pm
screen-shot-2014-09-15-at-4 11 33-pm
(Balsamiq Wireframe)
sign in page
(Beginning Antetype Wireframe)
signin

Jupyter-wide MathJax font choice

In the Jupyter Notebook meeting today, we reviewed jupyter/notebook #5998 and found that

  • one of the most compelling arguments for changing fonts is to create consistency across Jupyter projects
  • there is not currently a consistent/singular/otherwise agreed upon approach for this across projects
  • this PR is also linked to another PR asking to change fonts on JupyterLab

There seems to be a history of changing these fonts back and forth in some projects, so @afshin suggested that we agree on something and have a place to point people as to why the choice has been made to prevent changing this regularly in the future. Once a choice is made, I think it is worth adding a file to the repo to start tracking this and similar Jupyter-wide design choices.

I'm not very familiar with this problem and who at different projects might care about this, so I'd appreciate any help in getting those people involved.

Unified technical diagrams

I had a discussion with @ellisonbg about diagram design the other day and he suggested we come up with a unified technical diagram style, and that we ask @cameronoelsen to investigate for us. This discussion serves that purpose.

Next week, @Carreau @takluyver and I will be giving a talk at SciPy. I've chosen a simple diagram to start the discussion. Eventually I'd like to be able to animate the diagrams, but I don't think that's absolutely required right now.

Summary of needs:

  • Consistent diagram styling scheme (colors, shapes, lines, widths, fonts, etc).
  • Animated diagrams

Example diagram:
capture

It's important to state, the lines, shapes, and positioning I use in my sketch above can all be changed. Also the text "send" and "receive" can be omitted if it's clearer.

Import Error: No module named 'jupyter_cms'

I was running 'report_dashboard.ipynb' on cell 4: %load_ext jupyter_cms throws an error:

ImportError: No module named 'jupyter_cms'

I am using conda version 4, python 3.4 on windows 8.1 64-bit.
Also, conda install jupyter_cms throws an error:

package missing in current win-64 channel

[WIP] Notebook design idea

Hi all. Similar to the conversation going on in #6, I spent a small amount of time thinking about the design and layout of notebooks and thought I'd share a little bit of my work in progress.

I wanted to reduce some of the boxes, slim up the header space to bring the content up on the page, and make the Input and Output feel a bit more like an editor and be full-width/responsive.

Feedback welcome

jupyter notebook

Consolidating and Unifying Jupyter Logos

Currently, there are tons of Jupyter logos across multiple subprojects that are all slightly different from each other. The plan right now is to consolidate all of these and create one logo for everything.

The first picture shows versions of the Jupyter logo that are actually in use right now

  • A/E are the original logo
  • B is the logo found on the website's header
  • Everything else is found here and there throughout Jupyter

Currently there are 4 variables among the logos.

  • Gradient vs No gradient (E is the only one with a gradient)
  • Shade of orange (A is a lighter orange than B, C, and D)
  • Size of moons (B's moons are larger than the rest)
  • Color of moons (B and C have uniformly colored moons while A, D, and E have different colored moons)

The second photo shows all instances of Jupyter Logos actually being used in products right now. The last photo shows all versions of the logo I could find (including versions not being used anywhere).

What are everyone's thoughts and preferences? What parts of each logo do you like?

group 9
group 8
groupall

Who made the "community call" logo?

I like the "community call" logo that was done for the youtube videos. Who did that? And would you be willing to do the same for the Jupyter community forum? (basically just replace "community call" with "community forum"? @tgeorgeux was it you? :-)

JupyterLab Heuristic Evaluation

I’m part of a group from UC Irvine, working on designing a new file browser experience. As part of this work, we’ve been doing a lot of research on the current state of JupyterLab.
While it’s mostly focused on the file browsing/managing experience, the heuristic evaluation we’ve completed could be of some use to the community, so we’re sharing it here.

At the moment, I’m linking to this as stored in my personal .github.io repo, for lack of a better place, but are hoping @tgeorgeux can help us get this stored somewhere more appropriate/permanent for use by the Jupyter community.

Here’s hoping this is helpful, and thank you for your time.

Oh, and for reference, the group consists of @jabumeri, @JDLEarley, @emilythefan, @Nastraughn, and myself.

Brand guidelines cannot be updated

The current brand guidelines are a PDF export of presumably a presentation, but we don't seem to have the presentation anywhere in an editable format.

I know we set up a different, non-GitHub workflow for designers to contribute, but I can't find documentation of it, or how folks are supposed to propose updates to the brand guidelines right now (#68).

Font?

I assume the logo’s font is Myriad Pro Regular, but this is stated nowhere

Jupyter.org Redesign

We are a group of graduate students studying HCI and Design at the University of California, Irvine, and we have partnered with Project Jupyter to help maximize the effectiveness of the jupyter.org website as part of our six-month capstone project. We are working directly with Tim George, Jupyter’s lead UI/UX designer, and have already begun some preliminary UX research.

We will be adding new files into this repository so that the community can keep up to date with our progress.

Secondary Design Color

Hello all! At the Cal Poly hub we've been working on some branding decisions including updating brand guidelines and setting official print colors. In the process we're exploring adding in a palette of secondary colors to use with Jupyter Orange.

We'd love for anybody who's interested to be involved in the process with us. In the interest of productive work, there are a few constraints we will work within.

  • The secondary colors need to compliment existing Jupyter Orange.
  • We aren't working to change Jupyter Orange.
  • We want to focus first on developing 3 colors: A light fill color, a dark fill color, and a color we can use for text on light backgrounds.

I'll update progress here as it's made:

  • Scope secondary colors to a range that compliments Jupyter Orange
  • Try multiple shades, RGB combinations, CMYK combinations, to find a set of 'color candidates' that would work with Jupyter Orange
  • Of the selected colors play with Hue/Saturation/Lightness to find good matches that are easy on the eyes. Ideally a color candidate will be as close to the same base color with variation on lightness as possible. A good (good meaning works well with Jupyter Orange & White) candidate will have:
    • A good dark fill/accent color
    • A good light fill/accent color
    • A good 'text-on-light/white-background' color
  • Members of the community should feel this is a good (or good enough) color.

Business card templates?

Hey all - I was just chatting with @jzf2101 about how it'd be useful to have a business card to give to people when they wanna connect with the Jupyter community.

Do we have any business card templates that are easy for others to replicate? If not I can try to mock up and submit a PR

Survey existing logo styles

In developing our brand guide and trademark usage policies, it would be a good idea to understand all of the logo variations we already have. This would include:

  • Color variations
  • Moon sizes
  • Gradient or not.
  • Grey colors
  • etc.

Updating guidelines

I am working to update the Jupyter brand guidelines. Here are some of the things, in no particular order, that I am looking at adding/changing:

  • clearly summarize the how Jupyter logos can and can't be used, based on the trademark policy

  • clarify when the typography specified in the guidelines should be used

  • add square version of Powered by Jupyter logo to guidelines

  • Add CMYK values to Jupyter colors

  • Make collateral such as slide decks and business cards (both Jupyter-only and dual-logo) for community use and core contributor use

  • update email on last slide of guidelines

Please let me know if there is anything specific I should consider about these or any other points. I have looked at closed issues on this repo to understand where current designs came from.

Brand guidelines don't mention favicons

This repo has favicon files (lacking moons due to small display size), but they aren't mentioned in the brand guidelines. This means they can't easily be used according to our trademark policy.

I think we should mention the moonless favicon files in the guidelines and suggest using them for "small sizes" e.g. favicons or very small icons (I don't know if we want to go beyond subjective "very small" and suggest a specific display size, e.g. below 24px square).

Where to put design assets

In the past, we have been putting design assets on both:

  1. A shared DropBox folder
  2. This repo

The reason is that many of our designers haven't been git literate, and trying to diff/merge Illustrator files is really dangerous. The files in these two locations have fallen out of sync (they are completely different now) and the files are sort of a mess.

There are also a lot of "working" files, such as Illustrator and Sketch files that the designers use.

We need to organize and consolidate these assets.

Questions:

  • Where to put all of our final design files?
  • Where to put more of the working design files?
  • Should we force everyone to use Git?

@jupyter/designers

Survey for JupyterLab file browser redesign

Hello JupyterLab community! I am also part of a group from UC Irvine (we just recently dropped a Heuristic Evaluation and Competitive Analysis here) and as we continue with our research to design a new file browser experience, we we were hoping to gain some more input from the community.

To do that, our team has put together a survey to further understand the community's experience with JupyterLab. We believe the data collected from this survey will be very useful as we move forward in our research and design plans. Please take some time and complete it if you can; we would be very appreciative if you do!

https://forms.gle/1HAts3wNmmDk1JV38

Licenses for the logo?

Hey all - do we have any particular license for the Jupyter logo that's different from the codebase? I think we need to include this with the Binder blogpost. Maybe one of @ellisonbg @fperez would know?

JupyterLab UI/UX

Hey everyone!

Starting today, I am going to be shifting most of my focus to researching and designing the Jupyter Workbench's (name to be decided on) 1.0 initial release interface. @ellisonbg and I have started a Hackpad that outlines some common functionalities that we have seen users are accustomed to. Please feel free to add anything you might see to be a helpful feature/functionality to the end user for the initial release at https://jupyter.hackpad.com/Jupyter-Workbench-UIUX-m8yrTt4p5ZA. As I design the interface, it will be posted here for further discussion!

A new logo for IRkernel?

Hi!

A few changes or clarifications to the brand guidelines made it so the IRkernel logo (as well as a replacement by @cameronoelsen) don’t comply anymore:

irkernel-logo-old irkernel-logo-newer

But my programmer art really hits its limitations when i’m confronted with the task

Create a logo that adheres to the visual language of jupyter in a recognizable way without violating the brand guidelines

Would it be possible if you could help @takluyver, @JanSchulz and me out with a logo that fits those constraints?

As an inspiration: i really like the fact that the R logo fits the sidereus nuncius figure for jupiter that inspired the jupyter logo’s shells:

IPython Website Revamp

Over the last week, I have been doing a visual overhaul for both IPython and Jupyter. On the site I am sharing below, I simply took the content from the IPython site and did visual changes to make the site more modern. However, some of the content on the mockup provided is going to be moved over to the Jupyter site. The IPython site will be most likely less content heavy and more-so a direct to the Jupyter site once it is made. I have also allowed commenting on the mockup, so please feel free to provide feedback if you have any! The mockup is also very functional, so play around :) Cheers!

http://invis.io/KF3BRI8QU

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.