How to Install and Configure Altium - Revision history

Timv at 06:30, 23 August 2022

2022-08-23T06:30:40Z

← Older revision		Revision as of 06:30, 23 August 2022
Line 27:		Line 27:
	===Account Setup===		===Account Setup===
	[[File:TortoiseSVNMenu.png\|thumb\|200px\|right\|A screenshot showing all of the SVN functions available when right-clicking after installing TortoiseSVN. You will never use most of these.]]		[[File:TortoiseSVNMenu.png\|thumb\|200px\|right\|A screenshot showing all of the SVN functions available when right-clicking after installing TortoiseSVN. You will never use most of these.]]
	Within the {{slack-channel\|altium}} channel, request an account for Altium itself, the ~~Altium365~~ workspace~~, and the SVN~~. Messaging {{slack-user\|sunet-id=altium-admin\|display-name=altium-admin}} will summon the relevant person.		Within the {{slack-channel\|altium}} channel, request an account for Altium itself, and the Altium 365 workspace. Messaging {{slack-user\|sunet-id=altium-admin\|display-name=altium-admin}} will summon the relevant person. Once they give you an account, you should receive an email allowing you to log in to your account and access the [https://stanford-university-student-space-initiative.365.altium.com/ Altium 365 Workspace]. From the online workspace you can browse some recent projects without having to install any software.

			=== But I don't have a Windows computer! ===
			Never fear, many cool projects were designed without Windows computers! You have a few options:

			* Install Windows in a dual-boot configuration with your current OS (only for x86 computers, you'll need a bit of storage)
			* Run Windows in a local Virtual Machine (VM). [https://www.virtualbox.org/ VirtualBox] works well on many systems, and Stanford offers [https://stanford.onthehub.com/WebStore/Welcome.aspx VMWare for free], but for Apple Silicon (ARM) machines, [https://kb.parallels.com/124137 only Parallels supports DirectX], without which things will be very slow.
			* Connect to an [[Windows Remote VMs\|SSI hosted Virtual Machine (VM)]]. This works best when you're connected directly to a campus network.
			* Use an SSI desktop, in [[End station III\|ESIII]]. This works well, but can be inconvenient.

	===Installing Altium===		===Installing Altium===
Line 43:		Line 51:
	====Templates Location====		====Templates Location====
	[[File:DataManagementTemplates.png\|thumb\|200px\|right\|You will end up with something like this, unless you're attempting to steal my identity, in which case you will end up with ''exactly'' this.]]		[[File:DataManagementTemplates.png\|thumb\|200px\|right\|You will end up with something like this, unless you're attempting to steal my identity, in which case you will end up with ''exactly'' this.]]
	An unjustifiable length of time was spent creating formatting templates for SSI circuit schematics, which make for a clean, professional project and add a bit of information to each schematic. To use, in Preferences, go to "Data Management → Templates," and set the "Template location" field to point to the "libraries\templates" folder in your Altium SVN. See the image at right for an example of the result.		<s>An unjustifiable length of time was spent creating formatting templates for SSI circuit schematics, which make for a clean, professional project and add a bit of information to each schematic. To use, in Preferences, go to "Data Management → Templates," and set the "Template location" field to point to the "libraries\templates" folder in your Altium SVN. See the image at right for an example of the result.</s> '''TODO: Update the templates and these instructions.'''

	===Install the SSI PCB Logos Font===		===Install the SSI PCB Logos Font===
	Adding logos to PCBs is an important aspect of professionalism, part of SSI's agreements with its sponsors, and a nice way to add some creativity to a technical process. For logos that SSI commonly uses, we've created a font with scalable versions of each. ~~This~~ font ~~is stored in "~~libraries\logos\SSI~~" - there, you can double click on "SSI_logos~~.ttf~~" to~~ install it.		Adding logos to PCBs is an important aspect of professionalism, part of SSI's agreements with its sponsors, and a nice way to add some creativity to a technical process. For logos that SSI commonly uses, we've created a font with scalable versions of each. Download the font from [https://ssi-svn.stanford.edu/svn/altium-core/libraries/logos/SSI/SSI_Logos.ttf the SVN], and install it to your computer.

	===Remap Delete Key===		===Remap Delete Key===
	[[File:DeleteKeyRemapping18.png\|thumb\|200px\|right\|You should end up with this.]]		[[File:DeleteKeyRemapping18.png\|thumb\|200px\|right\|You should end up with this.]]
	''This step is only required of computers which do not have distinct "backspace" and "delete" keys. Desktops and most non-Apple laptops can skip this step. '''Apple laptops which have a "delete" key that functions as a backspace key need to complete this step.'''''		''This step is only required of computers which do not have distinct "backspace" and "delete" keys. Desktops and most non-Apple laptops can skip this step. '''Apple laptops which have a "delete" key that functions as a backspace key may need to complete this step.'''''

	If you do not have a schematic open already, open one by clicking "File → New → Schematic." Next, open up the Customize panel by either clicking on a blank space of the toolbar (the space to the right of the "Help" drop-down menu works) or by right-clicking in that same spot and selecting "Customize..." In the window that comes up (see right), click "Edit" from the "Categories" column on the left, then double click on "Delete" in the "Commands" column on the right. This is the command used to delete components from a schematic, which is by default mapped to the delete key, which, if you're completing this step, you do not have. Click the "Primary" field, and then hit your backspace key to remap the command to that key. This only changes the delete key for schematics, so repeat this process with a PCB document open.		If you do not have a schematic open already, open one by clicking "File → New → Schematic." Next, open up the Customize panel by either clicking on a blank space of the toolbar (the space to the right of the "Help" drop-down menu works) or by right-clicking in that same spot and selecting "Customize..." In the window that comes up (see right), click "Edit" from the "Categories" column on the left, then double click on "Delete" in the "Commands" column on the right. This is the command used to delete components from a schematic, which is by default mapped to the delete key, which, if you're completing this step, you do not have. Click the "Primary" field, and then hit your backspace key to remap the command to that key. This only changes the delete key for schematics, so repeat this process with a PCB document open.



	'''You're done!''' Welcome to Altium!		'''You're done!''' Welcome to Altium!
Line 64:		Line 70:

	==Addendum: SVN==		==Addendum: SVN==
	If you need a single file from the SSI SVN, you can download it from the [https://ssi-svn.stanford.edu/ web interface]. If you want to download many files, or make changes, you will need to [[SVN\|~~properly~~ check out the SVN repo]].		If you need a single file from the SSI SVN, you can download it from the [https://ssi-svn.stanford.edu/ web interface]. If you want to download many files, or make changes, you will need to [[SVN\|check out the SVN repo]].

	[[Category: Altium]]		[[Category: Altium]]

Timv at 05:15, 23 August 2022

2022-08-23T05:15:01Z

← Older revision		Revision as of 05:15, 23 August 2022
Line 64:		Line 64:

	==Addendum: SVN==		==Addendum: SVN==
	If you need a single file from the SSI SVN, you can download it from the [https://ssi-svn.stanford.edu/ web interface]. If you want to download many files, or make changes, you will need to [[~~Svn~~\|properly check out the SVN repo]].		If you need a single file from the SSI SVN, you can download it from the [https://ssi-svn.stanford.edu/ web interface]. If you want to download many files, or make changes, you will need to [[SVN\|properly check out the SVN repo]].

	[[Category: Altium]]		[[Category: Altium]]

Timv at 05:14, 23 August 2022

2022-08-23T05:14:28Z

@@ Line 64: / Line 64: @@
 ==Addendum: SVN==
+If you need a single file from the SSI SVN, you can download it from the [https://ssi-svn.stanford.edu/ web interface]. If you want to download many files, or make changes, you will need to [[Svn|properly check out the SVN repo]].
 [[Category: Altium]]

Timv at 05:03, 23 August 2022

2022-08-23T05:03:54Z

@@ Line 13: / Line 13: @@
 * All new projects are stored on Github. An example of this is [https://github.com/stanford-ssi/ThunderGuppy-EE ThunderGuppy-EE]. All SSI projects should be public on the [https://github.com/stanford-ssi SSI Github], but in order to commit changes, you're going to need to [https://github.com/join create a Github Account] and have someone add you as a member of the SSI Github organization. Ask in {{slack-channel|git}} to be added.
-* All components and parts live on the [https://stanford-university-student-space-initiative.365.altium.com/ Altium 365 workspace]. To access this you will need an Altium account connected to your Stanford email, and you will need to be added to the workspace. You should ask for these things in {{slack-channel|altium}}, and tag the {{slack-user|altium-admin}}.
+* All components and parts live on the [https://stanford-university-student-space-initiative.365.altium.com/ Altium 365 workspace]. To access this you will need an Altium account connected to your Stanford email, and you will need to be added to the workspace. You should ask for these things in {{slack-channel|altium}}, and tag the {{slack-user|sunet-id=altium-admin|display-name=altium-admin}}.
 * Templates, Logos, Fonts, and oddball SSI-wide data lives in the [https://ssi-svn.stanford.edu/svn/altium-core/ Altium SVN]. SVN ([https://subversion.apache.org/ Subversion]) is the grandfather to Git and Google Drive. To access the SVN you need credentials which you can get from https://ssi-svn.stanford.edu/ and an SVN client, like [https://tortoisesvn.net/ TortoiseSVN].
@@ Line 28: / Line 28: @@
 [[File:TortoiseSVNMenu.png|thumb|200px|right|A screenshot showing all of the SVN functions available when right-clicking after installing TortoiseSVN. You will never use most of these.]]
 Within the {{slack-channel|altium}} channel, request an account for Altium itself, the Altium365 workspace, and the SVN. Messaging {{slack-user|sunet-id=altium-admin|display-name=altium-admin}} will summon the relevant person.
 ===Installing Altium===
@@ Line 64: / Line 54: @@
 If you do not have a schematic open already, open one by clicking "File &rarr; New &rarr; Schematic." Next, open up the Customize panel by either clicking on a blank space of the toolbar (the space to the right of the "Help" drop-down menu works) or by right-clicking in that same spot and selecting "Customize..." In the window that comes up (see right), click "Edit" from the "Categories" column on the left, then double click on "Delete" in the "Commands" column on the right. This is the command used to delete components from a schematic, which is by default mapped to the delete key, which, if you're completing this step, you do not have. Click the "Primary" field, and then hit your backspace key to remap the command to that key. This only changes the delete key for schematics, so repeat this process with a PCB document open.
-===Background===
 An SVN repository is a series of "snapshots" of a folder over time. Each snapshot is called a '''commit''', and represents the state of the folder and some or all of its contents at a moment in time. Commits are created by users (aka you) when they want to preserve a version of the files they are working on - this typically happens after making a group of changes to files stored in the SVN repository (ie. after adding a part to a library or making progress on a circuit schematic or circuit board).
@@ Line 87: / Line 95: @@
 To finish, go back to your Altium SVN folder, right click while ''not'' on any file or folder, and mouse down to "SVN Commit..." and click it. A dialog box will come up (see right), at the bottom of which should be a list of files. This shows files you have changed since the last time you ran SVN update, and ''should'' just have iwuzhere.txt listed. Make sure you have it checked. In the text box at the top of the window, you will need to write a '''commit message''', a brief description of what changes you're committing. This message will appear in Slack and must be at least 20 characters (but shouldn't be longer than a single sentence). Once you've written it, click okay, and wait for a message to appear in Slack.
 [[Category: Altium]]

Timv at 04:53, 23 August 2022

2022-08-23T04:53:51Z

← Older revision		Revision as of 04:53, 23 August 2022
Line 27:		Line 27:
	===Account Setup===		===Account Setup===
	[[File:TortoiseSVNMenu.png\|thumb\|200px\|right\|A screenshot showing all of the SVN functions available when right-clicking after installing TortoiseSVN. You will never use most of these.]]		[[File:TortoiseSVNMenu.png\|thumb\|200px\|right\|A screenshot showing all of the SVN functions available when right-clicking after installing TortoiseSVN. You will never use most of these.]]
	Within the {{slack-channel\|altium}} channel, request an account for Altium itself, the Altium365 workspace, and the SVN. Messaging {{slack-user\|altium-admin}} will summon the relevant person.		Within the {{slack-channel\|altium}} channel, request an account for Altium itself, the Altium365 workspace, and the SVN. Messaging {{slack-user\|sunet-id=altium-admin\|display-name=altium-admin}} will summon the relevant person.

	===Installing SVN===		===Installing SVN===

Timv at 04:52, 23 August 2022

2022-08-23T04:52:04Z

← Older revision		Revision as of 04:52, 23 August 2022
Line 14:		Line 14:
	* All new projects are stored on Github. An example of this is [https://github.com/stanford-ssi/ThunderGuppy-EE ThunderGuppy-EE]. All SSI projects should be public on the [https://github.com/stanford-ssi SSI Github], but in order to commit changes, you're going to need to [https://github.com/join create a Github Account] and have someone add you as a member of the SSI Github organization. Ask in {{slack-channel\|git}} to be added.		* All new projects are stored on Github. An example of this is [https://github.com/stanford-ssi/ThunderGuppy-EE ThunderGuppy-EE]. All SSI projects should be public on the [https://github.com/stanford-ssi SSI Github], but in order to commit changes, you're going to need to [https://github.com/join create a Github Account] and have someone add you as a member of the SSI Github organization. Ask in {{slack-channel\|git}} to be added.
	* All components and parts live on the [https://stanford-university-student-space-initiative.365.altium.com/ Altium 365 workspace]. To access this you will need an Altium account connected to your Stanford email, and you will need to be added to the workspace. You should ask for these things in {{slack-channel\|altium}}, and tag the {{slack-user\|altium-admin}}.		* All components and parts live on the [https://stanford-university-student-space-initiative.365.altium.com/ Altium 365 workspace]. To access this you will need an Altium account connected to your Stanford email, and you will need to be added to the workspace. You should ask for these things in {{slack-channel\|altium}}, and tag the {{slack-user\|altium-admin}}.
	* Templates, Logos, Fonts, and oddball SSI-wide data lives in the altium SVN. SVN ([https://subversion.apache.org/ Subversion]) is the grandfather to Git and Google Drive. To access the SVN you need credentials ~~(ask in {{slack~~-~~channel\|altium}})~~ and an SVN client, like TortoiseSVN.		* Templates, Logos, Fonts, and oddball SSI-wide data lives in the [https://ssi-svn.stanford.edu/svn/altium-core/ Altium SVN]. SVN ([https://subversion.apache.org/ Subversion]) is the grandfather to Git and Google Drive. To access the SVN you need credentials which you can get from https://ssi-svn.stanford.edu/ and an SVN client, like [https://tortoisesvn.net/ TortoiseSVN].

	==A Brief Motivational Note==		==A Brief Motivational Note==

Timv at 04:39, 23 August 2022

2022-08-23T04:39:33Z

← Older revision		Revision as of 04:39, 23 August 2022
Line 1:		Line 1:
	{{guide\| authors=~~Sasha Maldonado~~ ({{slack-user\|smaldonado}}) and updated by ~~Tim Vrakas~~ ({{slack-user\|timv}})}}		{{guide\| authors=({{slack-user\|sunet-id=smaldonado\|display-name=Sasha Maldonado}}) and updated by ({{slack-user\|sunet-id=timv\|display-name=Tim Vrakas}})}}

	==Background==		==Background==

Timv at 01:49, 24 September 2020

2020-09-24T01:49:34Z

← Older revision		Revision as of 01:49, 24 September 2020
Line 1:		Line 1:
	{{guide\| authors=Sasha Maldonado ({{slack-user\|smaldonado}})}}		{{guide\| authors=Sasha Maldonado ({{slack-user\|smaldonado}}) and updated by Tim Vrakas ({{slack-user\|timv}})}}

	==Background==		==Background==

Timv at 06:09, 17 September 2020

2020-09-17T06:09:03Z

← Older revision		Revision as of 06:09, 17 September 2020
Line 27:		Line 27:
	===Account Setup===		===Account Setup===
	[[File:TortoiseSVNMenu.png\|thumb\|200px\|right\|A screenshot showing all of the SVN functions available when right-clicking after installing TortoiseSVN. You will never use most of these.]]		[[File:TortoiseSVNMenu.png\|thumb\|200px\|right\|A screenshot showing all of the SVN functions available when right-clicking after installing TortoiseSVN. You will never use most of these.]]
	Within the {{slack-channel\|altium}} channel, request an account for ~~both~~ Altium itself and ~~for~~ the SVN. Messaging {{slack-user\|altium-admin}} will summon the relevant person.		Within the {{slack-channel\|altium}} channel, request an account for Altium itself, the Altium365 workspace, and the SVN. Messaging {{slack-user\|altium-admin}} will summon the relevant person.

	===Installing SVN===		===Installing SVN===

Timv at 06:08, 17 September 2020

2020-09-17T06:08:08Z

← Older revision		Revision as of 06:08, 17 September 2020
Line 30:		Line 30:

	===Installing SVN===		===Installing SVN===
	~~''Skip this step if you're configuring a Lab 064 remote desktop''~~

	You will need SVN software to use the SSI Altium repository. The recommended choice is to install [http://tortoisesvn.net/ Tortoise SVN] (Windows-only). There are solutions for Mac and Linux users as well, though none quite as streamlined as TortoiseSVN; many Linux and Max users use the command line (Terminal) to handle SVN.		You will need SVN software to use the SSI Altium repository. The recommended choice is to install [http://tortoisesvn.net/ Tortoise SVN] (Windows-only). There are solutions for Mac and Linux users as well, though none quite as streamlined as TortoiseSVN; many Linux and Max users use the command line (Terminal) to handle SVN.